Skip to content

Add missing command docs + small style fixups #1937

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

Merged
merged 1 commit into from
Apr 7, 2025

Conversation

EliahKagan
Copy link
Member

Changes that affect the help/usage text shown at runtime:

  • Add descriptions for a few gix commands that didn't have it:
    gix is-clean, gix is-changed, and gix env.
  • Add a description of the debug-only ein panic command.
  • Small spacing and capitalization improvements for consistency.
  • Add a line break in a /// block for brevity of the top line.

Changes to code style that do not affect what is shown at runtime:

  • Add . at the end of some /// first lines.
    (This doesn't affect runtime behavior because clap normalizes this away.)
  • Put /// above all #[...] in a few places where it wasn't.
  • Adjust comment wrapping in a couple of places for clarity.

Changes that affect the help/usage text shown at runtime:

- Add descriptions for a few `gix` commands that didn't have it:
  `gix is-clean`, `gix is-changed`, and `gix env`.

- Add a description of the debug-only `ein panic` command.

- Small spacing and capitalization improvements for consistency.

- Add a line break in a `///` block for brevity of the top line.

Changes to code style that do not affect what is shown at runtime:

- Add `.` at the end of some `///` first lines. (This doesn't
  affect runtime behavior because `clap` normalizes this away.)

- Put `///` above all `#[...]` in a few places where it wasn't.

- Adjust comment wrapping in a couple of places for clarity.
@EliahKagan EliahKagan changed the title doc: Add missing command docs + small style fixups Add missing command docs + small style fixups Apr 7, 2025
@EliahKagan EliahKagan enabled auto-merge April 7, 2025 03:46
@EliahKagan EliahKagan merged commit de2f97d into GitoxideLabs:main Apr 7, 2025
22 checks passed
@EliahKagan EliahKagan deleted the document-commands branch April 7, 2025 04:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant