dcnm_bootflash: 01 cleanup docstrings #570
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit (and PR) does not contain any functional changes. It merely cleans up docstrings to conform to proper Markdown and adds module docstrings.
No functional changes.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR performs a comprehensive cleanup of docstrings across the dcnm_bootflash module and its related utilities. The changes convert docstrings from an inconsistent format to standardized Markdown, making them more readable and consistent. Module-level docstrings have been added to all affected files, and the heading structure has been normalized to use # for Summary sections and ## for major subsections like Raises, with ### for exception types.
Key Changes
- Standardized all docstring headings to use Markdown format (
#for Summary,##for major sections,###for subsections) - Added module-level docstrings to five files describing their purpose
- Converted inline code references from double backticks to single backticks for consistency
- Reformatted bullet lists and code examples to follow proper Markdown conventions
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| plugins/modules/dcnm_bootflash.py | Added module docstring; reformatted all method/class docstrings to use consistent Markdown headings and bullet formatting |
| plugins/module_utils/bootflash/convert_target_to_params.py | Added module docstring; standardized docstring formatting with proper Markdown structure and code examples |
| plugins/module_utils/bootflash/convert_file_info_to_target.py | Added module docstring; reformatted all docstrings to use consistent heading levels and Markdown conventions |
| plugins/module_utils/bootflash/bootflash_info.py | Added module docstring; normalized Raises sections to use consistent subsection headings |
| plugins/module_utils/bootflash/bootflash_files.py | Added module docstring; standardized all docstrings with proper Markdown formatting and improved readability |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No functional changes in this commit. 1. Fix typos 2. Remove extra backtick 3. Remove extra blank line 4. Minor reformatting of docstrings
allenrobel
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
There are no functional changes in this PR. It merely cleans up all method docstrings to conform to Markdown and adds module docstrings.
Notes to reviewers