-
Notifications
You must be signed in to change notification settings - Fork 8
Update README with corrected CLI commands and formatting #83
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
Conversation
- Update help output block to show correct commands:
- Remove non-existent: get-files-by-filter, get-files-by-project-accession,
get-private-files, get-projects, get-projects-by-accession
- Add missing: download-all-public-category-files, download-px-raw-files,
list-private-files
- Fix download-files-by-category -> download-all-public-category-files
- Use consistent 'pridepy' command instead of 'python -m pridepy.pridepy'
Fixes #82
https://claude.ai/code/session_017TpGVPTK44DCWtaSpVHaVj
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
|||||||||||||||||||||||
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
User description
Summary
Updated the README documentation to reflect the current CLI command names and improve formatting consistency throughout the guide.
Key Changes
Command list reorganization: Removed deprecated/renamed commands and updated the commands section with current command names:
download-files-by-category→download-all-public-category-filesget-files-by-filter→ removed (no longer listed)get-files-by-project-accession→ removed (no longer listed)get-private-files→list-private-filesget-projects→ removed (no longer listed)get-projects-by-accession→ removed (no longer listed)download-px-raw-filesCommand usage examples: Updated code examples to use correct command names:
download-all-public-category-filespython -m pridepy.pridepytopridepyfor consistencyFormatting improvements:
Notes
These changes ensure the documentation accurately reflects the current CLI interface and provides users with correct command names and usage patterns.
https://claude.ai/code/session_017TpGVPTK44DCWtaSpVHaVj
PR Type
Documentation
Description
Updated CLI command list to match actual implementation
Removed non-existent commands from help output
Added missing commands:
download-all-public-category-files,download-px-raw-files,list-private-filesFixed command invocation examples to use
pridepyinstead ofpython -m pridepy.pridepyImproved command list formatting with consistent alignment
Diagram Walkthrough
File Walkthrough
README.md
Corrected CLI commands and formatting in READMEREADME.md
(
get-files-by-filter,get-files-by-project-accession,get-private-files,get-projects,get-projects-by-accession)download-all-public-category-files,download-px-raw-files,list-private-filesdownload-files-by-categorytodownload-all-public-category-filespython -m pridepy.pridepytopridepyin two examples