Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for subcommands #2043

Merged
merged 3 commits into from
Aug 13, 2024
Merged

Add docs for subcommands #2043

merged 3 commits into from
Aug 13, 2024

Conversation

weiihann
Copy link
Contributor

Closes #2041

Copy link

codecov bot commented Aug 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.22%. Comparing base (66f8828) to head (251fb8d).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2043      +/-   ##
==========================================
+ Coverage   78.17%   78.22%   +0.04%     
==========================================
  Files         101      101              
  Lines        9064     9064              
==========================================
+ Hits         7086     7090       +4     
+ Misses       1345     1343       -2     
+ Partials      633      631       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@derrix060 derrix060 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I'd add a reference to this documentation in Readme.md though

@LordGhostX LordGhostX self-requested a review August 12, 2024 16:56
Copy link
Contributor

@LordGhostX LordGhostX left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

  • Restructured the subcommands section a bit
  • Released a new version (0.12.0), so the changes are live once this is merged

I also agree with the suggestion of adding the subcommands to the README

@LordGhostX LordGhostX added the Documentation Improvements or additions to documentation label Aug 12, 2024
@derrix060 derrix060 merged commit ca4ab37 into main Aug 13, 2024
10 checks passed
@derrix060 derrix060 deleted the weiihann/docs/db-cmd branch August 13, 2024 12:01
@kirugan
Copy link
Contributor

kirugan commented Aug 13, 2024

@LordGhostX but in 0.12.0 juno version we didn't add this command, it's only in main. Do you think it might lead to confussion?

@LordGhostX
Copy link
Contributor

@kirugan that's a good point. I thought the feature was live and was released in the last version (my bad)

I'll make a follow-up PR to remove the 0.12.0 docs release, then we do it another time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: add information about db command
4 participants