From f25e06b779f364b6da19e2a6e4dcc514683e5581 Mon Sep 17 00:00:00 2001 From: Rowan Walsh <1158758+rowan-walsh@users.noreply.github.com> Date: Tue, 23 Apr 2024 17:29:49 -0700 Subject: [PATCH 1/4] Fixes typo in docs --- docs/design/run.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/run.md b/docs/design/run.md index 7a045eef65..56b664e8d4 100644 --- a/docs/design/run.md +++ b/docs/design/run.md @@ -159,7 +159,7 @@ which are available as command options. It may be useful to execute commands in topological order. For example, commands with costs proportional to incremental changes, like build systems. -There may also be other revelant heuristics, but topological order is an easy +There may also be other relevant heuristics, but topological order is an easy and effective way to start. Parallel execution of commands on different commits may choose to schedule From d0cdef8fa07e39f693adc58311021a2237b1bf69 Mon Sep 17 00:00:00 2001 From: Rowan Walsh <1158758+rowan-walsh@users.noreply.github.com> Date: Tue, 23 Apr 2024 17:29:49 -0700 Subject: [PATCH 2/4] Fixes minor typo in script error message --- demos/run_scripts.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/demos/run_scripts.sh b/demos/run_scripts.sh index b728d967ef..f85506709f 100755 --- a/demos/run_scripts.sh +++ b/demos/run_scripts.sh @@ -14,7 +14,7 @@ set -euo pipefail # inkscape`. It's unclear to me whether `convert` used Inkscape or one of its # dependencies. Inkscape can be also used manually for SVG -> PNG conversion. which term-transcript > /dev/null \ - || (echo '`term-transcipt` must be installed with e.g.'\ + || (echo '`term-transcript` must be installed with e.g.'\ '`cargo binstall term-transcript-cli`.' \ 'See also https://github.com/slowli/term-transcript' >&2; false) From 4fa778acaab5c9a836fee93020ec146ac38e20c0 Mon Sep 17 00:00:00 2001 From: Rowan Walsh <1158758+rowan-walsh@users.noreply.github.com> Date: Tue, 23 Apr 2024 17:29:49 -0700 Subject: [PATCH 3/4] Fixes typo in 'jj git init' args --- cli/src/commands/git.rs | 2 +- cli/tests/cli-reference@.md.snap | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cli/src/commands/git.rs b/cli/src/commands/git.rs index 9122399631..9f22ca7c4b 100644 --- a/cli/src/commands/git.rs +++ b/cli/src/commands/git.rs @@ -115,7 +115,7 @@ pub struct GitRemoteListArgs {} pub struct GitInitArgs { /// The destination directory where the `jj` repo will be created. /// If the directory does not exist, it will be created. - /// If no directory is diven, the current directory is used. + /// If no directory is given, the current directory is used. /// /// By default the `git` repo is under `$destination/.jj` #[arg(default_value = ".", value_hint = clap::ValueHint::DirPath)] diff --git a/cli/tests/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index 6510c3c4ef..8c5a2e61e4 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -846,7 +846,7 @@ Create a new Git backed repo ###### **Arguments:** -* `` — The destination directory where the `jj` repo will be created. If the directory does not exist, it will be created. If no directory is diven, the current directory is used +* `` — The destination directory where the `jj` repo will be created. If the directory does not exist, it will be created. If no directory is given, the current directory is used Default value: `.` From 0bebcd77d27087db716ecb711cad23d154d808c2 Mon Sep 17 00:00:00 2001 From: Rowan Walsh <1158758+rowan-walsh@users.noreply.github.com> Date: Tue, 23 Apr 2024 18:20:41 -0700 Subject: [PATCH 4/4] Fixes grammar issues in docs --- docs/contributing.md | 2 +- docs/design/run.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 881185385a..a65fe0783e 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -35,7 +35,7 @@ function in order to add a new feature cleanly, put the refactoring in one commit and the new feature in a different commit. If the refactoring itself consists of many parts, try to separate out those into separate commits. You can use `jj split` to do it if you didn't realize ahead of time how it should be -split up. Include tests and documentation in the same commit as the code the +split up. Include tests and documentation in the same commit as the code they test and document. The commit message should describe the changes in the commit; the PR description can even be empty, but feel free to include a personal message. diff --git a/docs/design/run.md b/docs/design/run.md index 56b664e8d4..3c7883e089 100644 --- a/docs/design/run.md +++ b/docs/design/run.md @@ -194,7 +194,7 @@ running processes. Notify the user that we failed to apply the command to the specific revision. We will leave any affected commit in its current state, if any subprocess fails. -This allows us provide a better user experience, as leaving revisions in an +This allows us to provide a better user experience, as leaving revisions in an undesirable state, e.g partially formatted, may confuse users. ## Resource constraints