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.

Sign up for GitHub

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

Jump to bottom

Review and add examples to documentation #4

Open
4 of 11 tasks
joaopfonseca opened this issue Mar 6, 2022 · 0 comments
Open
4 of 11 tasks

Review and add examples to documentation #4

joaopfonseca opened this issue Mar 6, 2022 · 0 comments
Labels
Documentation Improvements or additions to documentation

Comments

@joaopfonseca
Copy link
Owner

joaopfonseca commented Mar 6, 2022 •
edited

The readthedocs page is getting a bit outdated:

  • Add support for Python 3.10
  • Add support for Python 3.11
  • Check for missing, deleted or renamed functions and objects
  • Review content as a whole
  • Add examples to documentation
  • Add dependency groups to documentation
  • README contains dependencies that will no longer be used
  • Set docstring variables
  • Set docstring tests
  • Abbreviate mlresearch in api docs page
  • Add funding information
@joaopfonseca joaopfonseca added the Documentation Improvements or additions to documentation label Mar 6, 2022
@joaopfonseca joaopfonseca changed the title Add examples to documentation Review and add examples to documentation Apr 13, 2022
joaopfonseca added a commit that referenced this issue Apr 13, 2022
@joaopfonseca
DOC fix grammar (#4)
f965b4f
joaopfonseca added a commit that referenced this issue Apr 13, 2022
@joaopfonseca
MNT add support for Python 3.10 (#4)
3c1aeaa
joaopfonseca added a commit that referenced this issue Apr 13, 2022
@joaopfonseca
DOC update dependencies list (#4)
898df27
@joaopfonseca joaopfonseca mentioned this issue Jan 6, 2023
Merged
joaopfonseca added a commit that referenced this issue Jan 8, 2023
@joaopfonseca
DOC add missing documentation (#4)
af1aca2
joaopfonseca added a commit that referenced this issue Jan 23, 2023
@joaopfonseca
DOC update API documentation (#4)
ffc0169
joaopfonseca added a commit that referenced this issue Jan 25, 2023
@joaopfonseca
DOC add missing documentation (#4)
1c672a0
joaopfonseca added a commit that referenced this issue Jan 25, 2023
@joaopfonseca
DOC update API documentation (#4)
8c1dd54
joaopfonseca added a commit that referenced this issue Oct 10, 2023
@joaopfonseca
DOC add pull request template (#4)
1fe8cf2
joaopfonseca added a commit that referenced this issue Dec 21, 2023
@joaopfonseca
DOC rename incorrect sections (#4)
8ba3fce
joaopfonseca added a commit that referenced this issue Dec 21, 2023
@joaopfonseca
DOC remove terms and glossary refs (#4)
b7b853a
joaopfonseca added a commit that referenced this issue Dec 28, 2023
@joaopfonseca
DOC rename incorrect sections (#4)
7e6f25c
joaopfonseca added a commit that referenced this issue Dec 28, 2023
@joaopfonseca
DOC remove terms and glossary refs (#4)
4a8dea2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@joaopfonseca