docs: updates docstrings for the CLI commands #350
Merged
Conversation
This file contains 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
|
🤖 Pull Request Artifacts (#11276141364) 🎉 |
pallabpain
force-pushed
the
docs/cli
branch
15 times, most recently
from
d77e20e
to
c98719c
Compare
pallabpain
force-pushed
the
docs/cli
branch
2 times, most recently
from
65dd7a7
to
42ea95b
Compare
pallabpain
changed the title
pallabpain
force-pushed
the
docs/cli
branch
from
42ea95b
to
9286733
Compare
pallabpain
commented
Sep 15, 2024
pallabpain
force-pushed
the
docs/cli
branch
2 times, most recently
from
2b8642c
to
5e1264d
Compare
pallabpain
force-pushed
the
docs/cli
branch
10 times, most recently
from
093e06f
to
cf13e17
Compare
pallabpain
force-pushed
the
docs/cli
branch
2 times, most recently
from
8fb6afb
to
00effe6
Compare
ankitrgadiya
requested changes
Oct 10, 2024
The CLI has lacked extensive documentation for most part and that leaves its users confused about its usage. This commit attempts to solve that problem by adding some elaborate docstrings to the commands with examples such that the users can figure out things by reading it.
pallabpain
commented
Oct 10, 2024
There was a problem hiding this comment.
@ankitrgadiya I have addressed the comments. Please take a look.
ankitrgadiya
approved these changes
Oct 10, 2024
|
🎉 This PR is included in version 9.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
Description
Adds extensive documentation for the CLI commands.