Skip to content

manual module listing#38

Open
George-Elhamy wants to merge 20 commits into
mainfrom
george
Open

manual module listing#38
George-Elhamy wants to merge 20 commits into
mainfrom
george

Conversation

@George-Elhamy
Copy link
Copy Markdown
Collaborator

Description

Motivation and Context

How Has This Been Tested?

Screenshots (only if appropriate, delete if not):

Types of changes

  • Bug fix
  • New feature
  • Breaking change (Causes existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • I have documented my changes in /docs/changelog.rst.
  • My change requires additional/updated documentation.
  • I have updated the documentation accordingly.
  • I have added/updated the config example for any module docstrings as necessary.
  • I have checked that the change does not contain obvious errors
    (syntax, indentation, mutable default values, etc.).
  • I have tested my changes using 'Load all modules' on the default dummy configuration.
  • All changed Jupyter notebooks have been stripped of their output cells.

@prithviulm prithviulm self-requested a review July 29, 2024 12:11
Copy link
Copy Markdown
Owner

@prithviulm prithviulm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just a minor comment about using os.path.join where possible.

Comment thread calculate_documentation_coverage.py Outdated
@prithviulm prithviulm self-requested a review August 15, 2024 09:37
Comment thread calculate_documentation_coverage.py
@prithviulm
Copy link
Copy Markdown
Owner

Also I see there are hundreds of files now added for the api autodoc in an _autosummary folder. Be careful, these should be generated by the docs building process (correct me if I'm wrong) and so should not be part of the repo. Please update the .gitignore (there is an existing pattern there to ignore _autosummary already but one directory higher) to handle this and remove these files.

@George-Elhamy
Copy link
Copy Markdown
Collaborator Author

Also I see there are hundreds of files now added for the api autodoc in an _autosummary folder. Be careful, these should be generated by the docs building process (correct me if I'm wrong) and so should not be part of the repo. Please update the .gitignore (there is an existing pattern there to ignore _autosummary already but one directory higher) to handle this and remove these files.

I've already added the _autosummary folder to the .gitignore and stopped its tracking in the branch, so check it and let me know if there is anything else to modify.

@prithviulm prithviulm self-requested a review August 26, 2024 11:47
Comment thread calculate_documentation_coverage.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants