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
As of right now, we're naively extracting documentation from Python docstrings. This could be improved significantly by putting in some more manual work: Careful consideration of what double-underscore methods to include, what order to present the documentation, etc.
Personally, I like the guiding principle of "tell a story" - Even documentation of a module's interface should have a natural flow that makes its intended use clear.
The text was updated successfully, but these errors were encountered:
As of right now, we're naively extracting documentation from Python docstrings. This could be improved significantly by putting in some more manual work: Careful consideration of what double-underscore methods to include, what order to present the documentation, etc.
Personally, I like the guiding principle of "tell a story" - Even documentation of a module's interface should have a natural flow that makes its intended use clear.
The text was updated successfully, but these errors were encountered: