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 module docstrings #256

Merged
merged 40 commits into from
Jan 23, 2024
Merged

Add module docstrings #256

merged 40 commits into from
Jan 23, 2024

Conversation

sajith
Copy link
Member

@sajith sajith commented Oct 25, 2023

Resolves #235 partly. Changes:

  • Adds module docstrings, with links to FABRIC glossary where it makes sense.
  • Avoids duplicating constructor docstrings as class docstrings. (Sphinx allows a choice between "init", "class", or "both", and I chose "class", because I thought the docs generated that way looked nicer.)

Please see the PR build to see the rendered version: https://fabric-fablib--256.org.readthedocs.build/en/256/index.html

@coveralls
Copy link
Collaborator

coveralls commented Oct 25, 2023

Pull Request Test Coverage Report for Build 7628803139

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.1%) to 22.239%

Totals Coverage Status
Change from base Build 7628190048: 0.1%
Covered Lines: 1158
Relevant Lines: 4641

💛 - Coveralls

@sajith sajith marked this pull request as ready for review October 27, 2023 17:31
@sajith sajith requested review from paul-ruth and kthare10 October 27, 2023 17:32
Copy link
Collaborator

@kthare10 kthare10 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!

@sajith sajith merged commit 2a7d36a into main Jan 23, 2024
14 checks passed
@sajith sajith deleted the 235.module-docs branch January 23, 2024 16:55
@sajith sajith mentioned this pull request Mar 11, 2024
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.

Missing docstrings
3 participants