fix: improve code quality and numpydoc documentation #4125
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
- Fix typo in _get_file_name docstring parameter description - Replace bare except clauses with specific OSError exceptions in launcher.py - Remove duplicate logging statement in licensing.py, use LOG.info instead - Add missing Parameters and Returns sections to Information class methods - Fix GL02 docstring formatting issues (closing quotes placement) - Add Returns section to convert.py format_using_autopep8 method
Reviewer's GuideThis PR enhances code quality by refactoring docstrings for NumPy style compliance, tightening exception handling in launcher.py, and cleaning up redundant logging in licensing.py without altering existing behavior. Class diagram for updated Information class documentationclassDiagram
class Information {
+__init__(mapdl: Mapdl)
+_mapdl: Mapdl
+_update() None
+__repr__() str
+product: str
+mapdl_version: str
+mapdl_version_update: str
+pymapdl_version: str
}
%% Note: Only docstrings and documentation were updated, no structural changes to methods or attributes.
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Pull Request Overview
This PR focuses on improving code quality and numpydoc documentation compliance across multiple MAPDL core files. The changes address docstring formatting issues, enhance exception handling, and clean up logging statements.
- Fixed a typo in docstring parameter description and improved exception handling specificity
- Enhanced numpydoc compliance by adding missing Parameters and Returns sections to documentation
- Cleaned up duplicate logging statements and improved docstring formatting consistency
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/ansys/mapdl/core/mapdl_core.py | Fixed typo in _get_file_name docstring parameter description |
| src/ansys/mapdl/core/licensing.py | Removed duplicate logging statement, consolidated to single LOG.info call |
| src/ansys/mapdl/core/launcher.py | Replaced bare except clauses with specific OSError exceptions |
| src/ansys/mapdl/core/information.py | Added missing Parameters section to class docstring and Returns sections to property methods |
| src/ansys/mapdl/core/convert.py | Added missing Returns section to format_using_autopep8 method |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
github-actions
bot
added
dependencies
maintenance
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #4125 +/- ##
=======================================
Coverage 91.30% 91.30%
=======================================
Files 189 189
Lines 15698 15706 +8
=======================================
+ Hits 14333 14341 +8
Misses 1365 1365 🚀 New features to boost your workflow:
|
github-actions
bot
removed
dependencies
maintenance
|
Skipping coverage since it is minor. @pyansys-ci-bot LGTM. |
|
My idea was to fix all the numpydocs issues in this PR. But it is waaay to much work for only one PR. So... this is just one. By filesDetails
COUNT | LINEBy issuesDetails
|
|
GL02 has been fixed in 920ddc2 |
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.
Related to
#2414
Summary
_get_file_namedocstring parameter descriptionChanges Made
Code Quality Improvements:
mapdl_core.py:3195- corrected "with our with extension" to "with or without extension"launcher.pyby replacing bareexcept:clauses with specificexcept OSError:licensing.pyby removing duplicate print statementNumpydoc Validation Fixes:
mapdlparameterTest plan
Summary by Sourcery
Improve code quality by replacing broad exception handlers and simplifying logging, and enhance API documentation by completing and correcting Numpydoc docstrings.
Enhancements:
Documentation: