No update to the code should break the documentation. This is implicitly guaranteed via backwards compatibility of the code. Let's find out when this happens.
Motivation
I recently found a bugreport of a problem that had been a problem for months, a complete showstopper for anyone new following along with the tutorial and a fresh install of Pyblish. This can never happen again.
Implementation
First approach will be to implement this here, as opposed to in the pyblish-by-example project, since pull requests here are more visible and documented, with a comment-section. The book is mostly edited via GitBook where each edit is a push into the main repository, whether it breaks or not.
They will ultimately both need testing when either change, so this is mainly a start.
Goal
No update to the code should break the documentation. This is implicitly guaranteed via backwards compatibility of the code. Let's find out when this happens.
Motivation
I recently found a bugreport of a problem that had been a problem for months, a complete showstopper for anyone new following along with the tutorial and a fresh install of Pyblish. This can never happen again.
Implementation
First approach will be to implement this here, as opposed to in the pyblish-by-example project, since pull requests here are more visible and documented, with a comment-section. The book is mostly edited via GitBook where each edit is a push into the main repository, whether it breaks or not.
They will ultimately both need testing when either change, so this is mainly a start.