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
While this is never a hard requirement, I think that it will just make it look better and more complete to a reviewer. I also believe that if you format the documentation in a certain way, you can hook it to be automatically formatted and consumed into your static documentation.
While this is never a hard requirement, I think that it will just make it look better and more complete to a reviewer. I also believe that if you format the documentation in a certain way, you can hook it to be automatically formatted and consumed into your static documentation.
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
I think it's worth the effort, if only just to make the docs look really nice.
Type hints It will also make it easier to play around with and debug for a novice user, who has some experience reading code.
The text was updated successfully, but these errors were encountered: