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
The docstrings are useful, but often users need more complete reference on how to use a given feature. Core developers know that correctness test examples exist for effectively everything in the language, but most users don't.
Perhaps the generated docs for features should link to a corresponding test program as a minimal example, where possible.
Perhaps other documentation that mentions a feature should consider doing so, as well.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
We have tutorials and READMEs, but our most complete documentation and reference really only exists in two places:
The docstrings are useful, but often users need more complete reference on how to use a given feature. Core developers know that correctness test examples exist for effectively everything in the language, but most users don't.
Beta Was this translation helpful? Give feedback.
All reactions