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
Right now, our documentation mixes API reference with implementation details. This is a direct consequence of efforts to reconstruct the legacy API on the fly and storing this knowledge in a accessable way.
In order to provide clean an focused documentation however, it is preferable to be stricter about those differing documentation aspects.
Docstrings shoudl provide a genreal API reference.
(Block)comments are to provide implementation notes.
The text was updated successfully, but these errors were encountered:
Right now, our documentation mixes API reference with implementation details. This is a direct consequence of efforts to reconstruct the legacy API on the fly and storing this knowledge in a accessable way.
In order to provide clean an focused documentation however, it is preferable to be stricter about those differing documentation aspects.
The text was updated successfully, but these errors were encountered: