Simplify command help descriptions#63
Merged
Merged
Conversation
Remove duplicated first lines between summary and description, strip information already obvious from flag definitions (required fields, validation rules, --yes behavior), and tighten all descriptions to be as short and clear as possible across all 92 command files. https://claude.ai/code/session_01SzyrJZ5eKMhsdJhfP1nc83
- notification/count.ts: count-notifications → count-notification (singular) - space/activities.ts: get-space-activities → get-recent-updates (correct page name) https://claude.ai/code/session_01SzyrJZ5eKMhsdJhfP1nc83
Change /ja/docs/ paths to /docs/ in issue-constants.ts for consistency with the rest of the codebase. https://claude.ai/code/session_01SzyrJZ5eKMhsdJhfP1nc83
The #activity-type anchor doesn't exist on the Nulab developer docs pages. The correct anchor is #response-description. https://claude.ai/code/session_01SzyrJZ5eKMhsdJhfP1nc83
Add two trailing spaces after "see:" so that Starlight (marked) renders a <br> instead of joining the URL on the same line. https://claude.ai/code/session_01SzyrJZ5eKMhsdJhfP1nc83
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
2 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.
Summary
Streamline help text for 100+ CLI commands by removing redundant phrasing and condensing verbose descriptions into concise, actionable guidance. This improves readability in the CLI help output while retaining essential information about command behavior.
Changes include:
--yesis provided." → "This action is irreversible.")Affected commands span all major areas: auth, issue, project, wiki, document, pull request, repository, user, notification, watching, and more.
Test plan
No testing needed. These are documentation-only changes to help text strings. The command functionality remains unchanged, and help text is verified by running
bee <command> --helpfor any command.https://claude.ai/code/session_01SzyrJZ5eKMhsdJhfP1nc83