cli commit: wrap each flag in backticks in doc comment
Some checks are pending
binaries / Build binary artifacts (push) Waiting to run
website / prerelease-docs-build-deploy (ubuntu-24.04) (push) Waiting to run
Scorecards supply-chain security / Scorecards analysis (push) Waiting to run

This commit is contained in:
Vincent Ging Ho Yim 2025-12-22 17:57:12 +11:00
parent 223470295e
commit e9b280148e
2 changed files with 6 additions and 5 deletions

View file

@ -47,11 +47,12 @@ use crate::ui::Ui;
/// * `jj commit` doesn't have a `-r` option. It always acts on the working-copy /// * `jj commit` doesn't have a `-r` option. It always acts on the working-copy
/// commit (@). /// commit (@).
/// ///
/// * `jj split` (without `-d/-A/-B`) will move bookmarks forward from the old /// * `jj split` (without `-d`/`-A`/`-B`) will move bookmarks forward from the
/// change to the child change. `jj commit` doesn't move bookmarks forward. /// old change to the child change. `jj commit` doesn't move bookmarks
/// forward.
/// ///
/// * `jj split` allows you to move the selected changes to a different /// * `jj split` allows you to move the selected changes to a different
/// destination with `-d/-A/-B`. /// destination with `-d`/`-A`/`-B`.
#[derive(clap::Args, Clone, Debug)] #[derive(clap::Args, Clone, Debug)]
pub(crate) struct CommitArgs { pub(crate) struct CommitArgs {
/// Interactively choose which changes to include in the current commit /// Interactively choose which changes to include in the current commit

View file

@ -624,9 +624,9 @@ When using `--interactive` or path arguments, the selected changes stay in the c
* `jj commit` doesn't have a `-r` option. It always acts on the working-copy commit (@). * `jj commit` doesn't have a `-r` option. It always acts on the working-copy commit (@).
* `jj split` (without `-d/-A/-B`) will move bookmarks forward from the old change to the child change. `jj commit` doesn't move bookmarks forward. * `jj split` (without `-d`/`-A`/`-B`) will move bookmarks forward from the old change to the child change. `jj commit` doesn't move bookmarks forward.
* `jj split` allows you to move the selected changes to a different destination with `-d/-A/-B`. * `jj split` allows you to move the selected changes to a different destination with `-d`/`-A`/`-B`.
**Usage:** `jj commit [OPTIONS] [FILESETS]...` **Usage:** `jj commit [OPTIONS] [FILESETS]...`