Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Arithmetic progression function #34

Closed
vrudhgarg opened this issue Jan 21, 2025 · 0 comments · Fixed by #42 or #40
Closed

Add documentation for Arithmetic progression function #34

vrudhgarg opened this issue Jan 21, 2025 · 0 comments · Fixed by #42 or #40
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@vrudhgarg
Copy link
Collaborator

Please follow these guidelines:

  1. 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.
  2. There should be clear and well written narrative to go along with the code examples in the vignette.
  3. Essentially, this documentations should enable any user with minimal expertise to be able to run your package functions and play around with them.
  4. All function documentation should be rendered using the napolean Sphinx extension and readable on ReadTheDocs..
  5. Your vignette should be a Jupyter notebook in the docs folder.
@vrudhgarg vrudhgarg added this to the Milestone 3 milestone Jan 21, 2025
@vrudhgarg vrudhgarg self-assigned this Jan 21, 2025
@vrudhgarg vrudhgarg added the documentation Improvements or additions to documentation label Jan 21, 2025
@vrudhgarg vrudhgarg moved this to In review in Number Theory Jan 23, 2025
@vrudhgarg vrudhgarg moved this from In review to Done in Number Theory Jan 25, 2025
@vrudhgarg vrudhgarg closed this as completed by moving to Done in Number Theory Jan 25, 2025
This was linked to pull requests Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
1 participant