From 86de9139b34734b7dc90d8502c7789818a42e29d Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Thu, 7 Nov 2024 20:36:09 -0800 Subject: [PATCH] docs: fix a few typos noticed by automation at Google --- docs/contributing.md | 2 +- docs/design/run.md | 10 +++++----- docs/templates.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 3bf04dd4e..f4a2639b8 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -42,7 +42,7 @@ 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. We start the commit message with `: ` and don't use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). This means if -you modified a command in the CLI, use its name as the topic, e.g +you modified a command in the CLI, use its name as the topic, e.g. `next/prev: ` or `conflicts: `. We don't currently have a specific guidelines on what to write in the topic field, but the reviewers will help you provide a topic if you have difficulties choosing diff --git a/docs/design/run.md b/docs/design/run.md index 5bb6606b2..fc2718feb 100644 --- a/docs/design/run.md +++ b/docs/design/run.md @@ -107,10 +107,10 @@ reused between `jj run` invocations. They will also be reused within `jj run` invocation if there are more commits to run on than there are parallel jobs. We will leave ignored files in the temporary directory between runs. That -enables incremental builds (e.g by letting cargo reuse its `target/` directory). -However, it also means that runs potentially become less reproducible. We will -provide a flag for removing ignored files from the temporary working copies to -address that. +enables incremental builds (e.g. by letting cargo reuse its `target/` +directory). However, it also means that runs potentially become less +reproducible. We will provide a flag for removing ignored files from the +temporary working copies to address that. Another problem with leaving ignored files in the temporary directories is that they take up space. That is especially problematic in the case of cargo (the @@ -135,7 +135,7 @@ assigned working copy. Let's say the user runs `jj run` on just commits A and B, where B's parent is A. Any changes made on top of A would be squashed into A, forming A'. Similarly B' would be formed by squasing it into B. We can then either do a normal rebase of B' onto A', or we can simply update its parent to -A'. The former is useful, e.g when the subprocess only makes a partial update +A'. The former is useful, e.g. when the subprocess only makes a partial update of the tree based on the parent commit. In addition to these two modes, we may want to have an option to ignore any changes made in the subprocess's working copy. diff --git a/docs/templates.md b/docs/templates.md index 6fde385df..aac8f7414 100644 --- a/docs/templates.md +++ b/docs/templates.md @@ -61,7 +61,7 @@ The following functions are defined. the content. The `label` is evaluated as a space-separated string. * `raw_escape_sequence(content: Template) -> Template`: Preserves any escape sequences in `content` (i.e., bypasses sanitization) and strips labels. - Note: This function is intended for escape sequences and as such, it's output + Note: This function is intended for escape sequences and as such, its output is expected to be invisible / of no display width. Outputting content with nonzero display width may break wrapping, indentation etc. * `if(condition: Boolean, then: Template[, else: Template]) -> Template`: