generate run arg doc from scripts#747
Merged
AnguseZhang merged 10 commits intodeepmodeling:develfrom Jul 5, 2022
Merged
Conversation
This commit generates run argument documentations from scripts at runtime, so we can work on the script to improve the docs.
AnguseZhang
reviewed
Jun 8, 2022
Collaborator
AnguseZhang
left a comment
AnguseZhang
left a comment
There was a problem hiding this comment.
@njzjz Great work! @LiangWenshuo1118 Please help check.
wanghan-iapcm
approved these changes
Jun 9, 2022
Member
Author
|
Removed |
Codecov Report
@@ Coverage Diff @@
## devel #747 +/- ##
==========================================
- Coverage 34.81% 34.60% -0.21%
==========================================
Files 96 96
Lines 16633 16733 +100
==========================================
Hits 5790 5790
- Misses 10843 10943 +100
Continue to review full report at Codecov.
|
Member
Author
|
Switched to new dargs directive. |
Member
Author
|
The following is missing:
Considering it's too much, we may submit separated PRs to add them. |
HuangJiameng
approved these changes
Jul 5, 2022
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
5 participants
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.
This commit generates run argument documentation from scripts (inited by @LiangWenshuo1118) at runtime, so we can work together on the script to improve the docs.
I see some arguments are still missing here...