Open
Conversation
No functional changes in this commit. Run black and isort.
No functional changes in this commit. Run black and isort linters against MaintenanceMode.
No functional changes in this commit. Run black and isort linters against dcnm_maintenance_mode.py.
No functional changes in this commit. Run black and isort linters against unit test files for dcnm_maintenance_mode.
No functional changes in this commit. This commit updates all docstrings to conform to the standards defined in CLAUDE.md (not in this repository). These standards include: 1. Structured headings # Summary ## Raises ### ValueError ## Other heading …etc 2. Single backticks around class, method, var, names, exception names, etc.
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request updates docstrings across the dcnm_maintenance_mode module and related test files to conform with standards defined in CLAUDE.md. The changes include:
- Reformatting docstring headers from
###to#for top-level summaries and using##and###for subsections - Consolidating multi-line import statements to single lines for better readability
- Converting inline code references to use backticks consistently
- Restructuring docstring sections with consistent headings (Summary, Raises, Details, Usage, etc.)
- Updating JSON examples in docstrings to use proper quoting
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/unit/modules/dcnm/dcnm_maintenance_mode/utils.py | Consolidated multi-line imports into single lines |
| tests/unit/modules/dcnm/dcnm_maintenance_mode/test_dcnm_maintenance_mode_want.py | Consolidated multi-line imports into single lines |
| tests/unit/modules/dcnm/dcnm_maintenance_mode/test_dcnm_maintenance_mode_query.py | Consolidated imports and reformatted import lists |
| tests/unit/modules/dcnm/dcnm_maintenance_mode/test_dcnm_maintenance_mode_params_spec.py | Consolidated multi-line imports into single lines |
| tests/unit/modules/dcnm/dcnm_maintenance_mode/test_dcnm_maintenance_mode_merged.py | Consolidated imports and reformatted import lists, simplified string concatenation |
| tests/unit/modules/dcnm/dcnm_maintenance_mode/test_dcnm_maintenance_mode_common.py | Consolidated multi-line imports into single lines |
| tests/unit/module_utils/common/test_maintenance_mode_info.py | Reformatted test docstrings to use new standard format with # and ## headings |
| tests/unit/module_utils/common/test_maintenance_mode.py | Reformatted test docstrings and consolidated imports; simplified function signatures |
| plugins/modules/dcnm_maintenance_mode.py | Comprehensive docstring reformatting for all classes and methods; added blank line after imports; standardized JSON examples |
| plugins/module_utils/common/maintenance_mode_info.py | Comprehensive docstring reformatting; reordered imports to follow standard (local before relative) |
| plugins/module_utils/common/maintenance_mode.py | Comprehensive docstring reformatting; consolidated multi-line imports |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tests/unit/modules/dcnm/dcnm_maintenance_mode/test_dcnm_maintenance_mode_common.py
Show resolved
Hide resolved
Fix below error: ERROR: tests/unit/module_utils/common/test_maintenance_mode.py:1238:161: E501: line too long (181 > 160 characters)
allenrobel
changed the title
No functional changes in this commit. 1. Update all docstrings to conform to Markdown format. 2. Add module dostrings where missing. 3. Add pylint supression directive for __metaclass__ invalid-name
No functional changes in this commit. Update copyright dates for all unit test files associuated with dcnm_maintenance_mode.
allenrobel
added
ready for review
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
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.
Update docstrings for all files that are directly related to the dcnm_maintainence_mode module to conform with standards defined in CLAUDE.md.
Notes to reviewers
TBD
Files changed