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
Include an article/vignette demonstrating how to use all your package functions on a more real-life example than the examples in the function documentation.
There should be clear and well written narrative to go along with the code examples in the vignette.
Essentially, this documentations should enable any user with minimal expertise to be able to run your package functions and play around with them.
All function documentation should be rendered using the napolean Sphinx extension and readable on ReadTheDocs..
Your vignette should be a Jupyter notebook in the docs folder.
The text was updated successfully, but these errors were encountered:
Please follow these guidelines:
The text was updated successfully, but these errors were encountered: