docs: sync modctl man page with CLI and replace hardcoded default path#426
docs: sync modctl man page with CLI and replace hardcoded default path#426rishi-jat wants to merge 5 commits intomodelpack:mainfrom
Conversation
…rectory Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refines the Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request aims to fix a hardcoded user-specific path in the documentation. The change replaces the specific path with a generic home directory reference (~/.modctl), which is a good improvement. However, I've added a review comment regarding the maintainability of this change, as it appears to be made to a file that may be auto-generated. Modifying the source of the documentation generation would be a more robust solution.
There was a problem hiding this comment.
Pull request overview
Updates the modctl man page to avoid a developer-specific default storage directory path by using a generic home-directory-based default.
Changes:
- Replace the hardcoded default storage directory path in the
--storage-dirflag documentation with~/.modctl.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
chlins
left a comment
There was a problem hiding this comment.
Please check the output after running the command; standardize the command output here completely. I think the description section is also outdated at the moment.
|
Thanks for the review. I’ve updated the man page to fully match the current |
05a468a to
7245dba
Compare
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
7245dba to
05605ab
Compare
|
Note: I used the latest release version (v0.1.2) in the man page header. |
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Description
This PR synchronizes
build/package/docs/modctl.1.mdwith the currentmodctl --helpoutput.Changes
~/.modctl)The goal is to ensure the man page remains accurate, consistent, and fully aligned with the current CLI behavior.