docs: move arg docs from Variant to sub Arguments #4369
Conversation
See deepmodeling/dargs#82 Signed-off-by: Jinzhe Zeng <[email protected]>
There was a problem hiding this comment.
Copilot reviewed 1 out of 1 changed files in this pull request and generated no suggestions.
📝 WalkthroughWalkthroughThe changes in this pull request focus on enhancing the documentation within the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ArgCheck
User->>ArgCheck: Request descriptor registration
ArgCheck->>ArgCheck: Register descriptor with documentation
ArgCheck-->>User: Provide confirmation of registration
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
deepmd/utils/argcheck.py (3)
43-57: Documentation is clear but could be enhanced further.The documentation strings are well-written and informative. Consider these enhancements:
- Add code examples for complex configurations
- Add cross-references to related parameters
- Include typical value ranges where applicable
Example enhancement for
doc_se_e2_a:-doc_se_e2_a = "Used by the smooth edition of Deep Potential. The full relative coordinates are used to construct the descriptor." +doc_se_e2_a = """Used by the smooth edition of Deep Potential. The full relative coordinates are used to construct the descriptor. + +Example configuration: +```python +{ + "type": "se_e2_a", + "sel": [46, 92], + "rcut": 6.0, + "rcut_smth": 0.5 +} +``` + +Related parameters: +- sel: Number of neighbors to select +- rcut: Cutoff radius +- rcut_smth: Smoothing cutoff +"""
Line range hint
247-268: Backend-specific notes could be more prominent.The backend-specific notes (e.g., "Supported Backend: TensorFlow") are included in the documentation but could be more prominent. Consider:
- Using a consistent format for backend support notes
- Adding visual separation for backend-specific sections
- Including version requirements if applicable
Example enhancement:
-@descrpt_args_plugin.register("loc_frame", doc=doc_only_tf_supported + doc_loc_frame) +@descrpt_args_plugin.register( + "loc_frame", + doc=f""" + {doc_only_tf_supported} + ---------------------------------------- + {doc_loc_frame} + """ +)Also applies to: 336-338, 393-395
1365-1365: Consider adding type hints to improve code maintainability.The function registrations would benefit from explicit return type hints. This would improve code maintainability and IDE support.
Example enhancement:
-@descrpt_args_plugin.register("se_a_mask", doc=doc_only_tf_supported + doc_se_a_mask) -def descrpt_se_a_mask_args(): +@descrpt_args_plugin.register("se_a_mask", doc=doc_only_tf_supported + doc_se_a_mask) +def descrpt_se_a_mask_args() -> list[Argument]:Also applies to: 1419-1419, 1432-1432, 1508-1508, 1596-1596, 1650-1650, 1689-1691, 1720-1727
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## devel #4369 +/- ##
==========================================
- Coverage 84.50% 84.50% -0.01%
==========================================
Files 596 596
Lines 56665 56670 +5
Branches 3459 3460 +1
==========================================
+ Hits 47884 47888 +4
Misses 7654 7654
- Partials 1127 1128 +1 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
|
|
See deepmodeling/dargs#82
Summary by CodeRabbit