Skip to content

docs: add help text to CLI options#35

Merged
Nelson Spence (Fieldnote-Echo) merged 1 commit intoProject-Navi:mainfrom
passionworkeer:main
Mar 11, 2026
Merged

docs: add help text to CLI options#35
Nelson Spence (Fieldnote-Echo) merged 1 commit intoProject-Navi:mainfrom
passionworkeer:main

Conversation

@passionworkeer
Copy link
Contributor

@passionworkeer Jianjun Wang (passionworkeer) commented Mar 10, 2026

Add help text to CLI options missing descriptions in validate, render, apply, and diff commands.

Closes #30

Description

Type of Change

  • Bug fix
  • New feature
  • Documentation
  • Test coverage
  • Refactor
  • Security
  • Breaking change

Checklist

  • My code follows the project's style (ruff check src/navi_bootstrap/ tests/)
  • I have added tests for my changes
  • I have updated documentation if needed
  • All existing tests pass (pytest tests/ -v)

Related Issues

Additional Notes

@passionworkeer
docs: add help text to CLI options
d43f095 
Add help text to CLI options missing descriptions in validate, render, apply, and diff commands.

Closes Project-Navi#30
Copilot AI review requested due to automatic review settings March 10, 2026 16:39
Copilot AI reviewed Mar 10, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves the nboot CLI usability by adding missing help= text to Click options across the validate, render, apply, and diff commands (per Issue #30).

Changes:

  • Added help text for --spec and --pack on validate.
  • Added help text for --spec, --pack, --out, and --dry-run on render.
  • Added help text for --spec, --pack, and --dry-run on apply.
  • Added help text for --spec and --pack on diff.

@Fieldnote-Echo
Copy link
Member

Nelson Spence (Fieldnote-Echo) commented Mar 11, 2026

Hey Jianjun Wang (@passionworkeer) — thanks for jumping on this!

We're currently drafting contributor guidelines (CONTRIBUTING.md) to make expectations around formatting, local checks, and PR structure clearer for everyone. Once that's in place, we'll follow up with specific feedback on this PR.

Hang tight — more to come shortly.

@codecov
Copy link

codecov bot commented Mar 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

project-navi-bot
project-navi-bot approved these changes Mar 11, 2026
View reviewed changes
Copy link
Collaborator

@project-navi-bot project-navi-bot left a comment

Choose a reason for hiding this comment

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

All required CI checks passed. Auto-approved by navi-bot.

project-navi-bot
project-navi-bot approved these changes Mar 11, 2026
View reviewed changes
Copy link
Collaborator

@project-navi-bot project-navi-bot left a comment

Choose a reason for hiding this comment

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

Auto-approved by navi-bot.

@Fieldnote-Echo Nelson Spence (Fieldnote-Echo) merged commit bec32e9 into Project-Navi:main Mar 11, 2026
7 of 9 checks passed
Nelson Spence (Fieldnote-Echo) added a commit that referenced this pull request Mar 12, 2026
@Fieldnote-Echo
revert: undo external PRs #34 and #35 for quality review
0b5ddcb 
Reverts changes from:
- #35 (passionworkeer): CLI help text additions
- #34 (RogueTex): async test detection regex

Issues #30 and #32 remain open for proper reimplementation.
Merged
Nelson Spence (Fieldnote-Echo) added a commit that referenced this pull request Mar 12, 2026
@Fieldnote-Echo
revert: undo external PRs #34 and #35 for quality review (#40)
6fb2afb 
Reverts changes from:
- #35 (passionworkeer): CLI help text additions
- #34 (RogueTex): async test detection regex

Issues #30 and #32 remain open for proper reimplementation.
Open
@Fieldnote-Echo
Copy link
Member

Nelson Spence (Fieldnote-Echo) commented Mar 12, 2026

Hey Jianjun Wang (@passionworkeer) — apologies for the mess here. We had some CI infrastructure changes going through (ruleset updates, check name standardization) and your PR got caught in the crossfire during the migration. We've reverted and recreated your changes in #41 with proper attribution.

We'll provide substantive feedback on the PR tomorrow. Thanks for your patience and your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@project-navi-bot project-navi-bot project-navi-bot approved these changes

@Fieldnote-Echo Nelson Spence (Fieldnote-Echo) Awaiting requested review from Fieldnote-Echo Fieldnote-Echo is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add help text to CLI options missing descriptions

4 participants

@passionworkeer @Fieldnote-Echo @project-navi-bot