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
If our aim is to have others contribute to this project, we need to provide clear and thorough documentation. Note that good documentation will also be beneficial for us in the future!
Backend: As the backend is Python, Sphinx documentation is widely available.
Frontend: For the Javascript frontend, we might use something like Sphinx-js to ensure consistency throughout.
❗ Note that when providing clear documentation, we need to decide upon a documentation style. I personally like numpydoc, but if we do not use NumPy a lot we can switch to other options. At least we should try to be as consistent as possible throughout the entire project.
The text was updated successfully, but these errors were encountered:
Is this feature already implemented or suggested?
Suggested feature
If our aim is to have others contribute to this project, we need to provide clear and thorough documentation. Note that good documentation will also be beneficial for us in the future!
❗ Note that when providing clear documentation, we need to decide upon a documentation style. I personally like numpydoc, but if we do not use NumPy a lot we can switch to other options. At least we should try to be as consistent as possible throughout the entire project.
The text was updated successfully, but these errors were encountered: