You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I find it shocking ; imho a documentation should be attached/stored along to what it is documenting..
So that if/when an API/feature/whatever is changed/introduced then the relevant documentation should also be changed/introduced ; in the same branch or even commit.
Most (very well maintained) opensource software projects are doing this, I can give plenty of them very good : Django, celery, requests, flask, tornado, ansible, sentry, scrapy, ipython, boto, etc, etc etc (and etc..) ..
In fact this is really very common (and best) practice to include the documentation of a software in the same repository than the source code itself..
The text was updated successfully, but these errors were encountered:
I find it shocking ; imho a documentation should be attached/stored along to what it is documenting..
So that if/when an API/feature/whatever is changed/introduced then the relevant documentation should also be changed/introduced ; in the same branch or even commit.
Most (very well maintained) opensource software projects are doing this, I can give plenty of them very good : Django, celery, requests, flask, tornado, ansible, sentry, scrapy, ipython, boto, etc, etc etc (and etc..) ..
In fact this is really very common (and best) practice to include the documentation of a software in the same repository than the source code itself..
The text was updated successfully, but these errors were encountered: