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 missng docstrings in resources module #366

Merged
merged 5 commits into from
Sep 16, 2024
Merged

Conversation

sajith
Copy link
Member

@sajith sajith commented Sep 16, 2024

Addresses #315.

These docstrings are kind of silly and probably not very useful, but I would like to check that box off in #308. This PR addresses some warnings when building docs with sphinx-build -W, so that might be useful.

These are the warnings:

> fabrictestbed_extensions/fablib/fablib.py:docstring of
> fabrictestbed_extensions.fablib.fablib.FablibManager.get_slice_manager:8:Field
> list ends without a blank line; unexpected unindent. [docutils]

and:

> fabrictestbed_extensions/fablib/fablib.py:docstring of
> fabrictestbed_extensions.fablib.fablib.FablibManager.set_slice_manager:7:Field
> list ends without a blank line; unexpected unindent. [docutils]
@sajith sajith self-assigned this Sep 16, 2024
@sajith sajith added the documentation Improvements or additions to documentation label Sep 16, 2024
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!

@coveralls
Copy link
Collaborator

coveralls commented Sep 16, 2024

Pull Request Test Coverage Report for Build 10886880669

Details

  • 3 of 3 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.03%) to 17.569%

Totals Coverage Status
Change from base Build 10782813054: 0.03%
Covered Lines: 1383
Relevant Lines: 5675

💛 - Coveralls

@sajith sajith merged commit 985e6aa into main Sep 16, 2024
20 checks passed
@sajith sajith deleted the 315.resources-docstrings branch September 16, 2024 15:24
@sajith sajith linked an issue Sep 16, 2024 that may be closed by this pull request
sajith added a commit that referenced this pull request Sep 16, 2024
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
None yet
Development

Successfully merging this pull request may close these issues.

Add missing function docstrings in fablib.resources
3 participants