Skip to contentSkip to conversation

gitignore.txt: use backticks instead of double quotes

PATCH In review jr via GitGitGadget 2 participants 2 messages Jul 18, 2023 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 gitignore.txt: use backticks instead of double quotes

From: Johan Ruokangas <[email protected]>

unifies highlighting with the rest of the documentation

---
gitignore.txt: use backticks instead of double quotes

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1553%2Fjozan%2Fbackticks-gitignore-doc-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1553/jozan/backticks-gitignore-doc-v1
Pull-Request: https://github.com/git/git/pull/1553

 Documentation/gitignore.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/gitignore.txt +4 -4
index 4c17f2356c4..810041acd17 100644
@@ -174,10 +174,10 @@ EXAMPLES
    is not relevant  if there is already a middle slash in
    the pattern.
 
- - The pattern "foo/*", matches "foo/test.json"
-   (a regular file), "foo/bar" (a directory), but it does not match
-   "foo/bar/hello.c" (a regular file), as the asterisk in the
-   pattern does not match "bar/hello.c" which has a slash in it.
+ - The pattern `foo/*`, matches `foo/test.json`
+   (a regular file), `foo/bar` (a directory), but it does not match
+   `foo/bar/hello.c` (a regular file), as the asterisk in the
+   pattern does not match `bar/hello.c` which has a slash in it.
 
 --------------------------------------------------------------
     $ git status

base-commit: 5e238546dc7a232d8998f1cd1ec9d3f4a0add68b

Signature · 1 line
gitgitgadget
#1 lore raw
Quoted 3 lines · jr via GitGitGadget

From: Johan Ruokangas <[email protected]>

unifies highlighting with the rest of the documentation

I find "The rest of the documentation" is a bit of overstatement, but something like

Among four examples, only this one used "double quoted" sample patterns, but all others marked up the patterns in monospace.

would be a good justification. The change is good.

A change in the same vein elsewhere in the same document ...

Documentation/gitignore.txt +1 -1
index 4c17f2356c..bf2d823c94 100644
@@ -88,7 +88,7 @@ PATTERN FORMAT
    Put a backslash ("`\`") in front of the first "`!`" for patterns
    that begin with a literal "`!`", for example, "`\!important!.txt`".
 
- - The slash '/' is used as the directory separator. Separators may
+ - The slash "`/`" is used as the directory separator. Separators may
    occur at the beginning, middle or end of the `.gitignore` search pattern.
 
  - If there is a separator at the beginning or middle (or both) of the

... would be sufficient to make the PATTERN FORMAT section consistent, I think.

Quoted 1 line

Thanks, will queue.

Quoted 21 lines
Documentation/gitignore.txt +4 -4
index 4c17f2356c4..810041acd17 100644
@@ -174,10 +174,10 @@ EXAMPLES
    is not relevant  if there is already a middle slash in
    the pattern.
 
- - The pattern "foo/*", matches "foo/test.json"
-   (a regular file), "foo/bar" (a directory), but it does not match
-   "foo/bar/hello.c" (a regular file), as the asterisk in the
-   pattern does not match "bar/hello.c" which has a slash in it.
+ - The pattern `foo/*`, matches `foo/test.json`
+   (a regular file), `foo/bar` (a directory), but it does not match
+   `foo/bar/hello.c` (a regular file), as the asterisk in the
+   pattern does not match `bar/hello.c` which has a slash in it.
 
 --------------------------------------------------------------
     $ git status

base-commit: 5e238546dc7a232d8998f1cd1ec9d3f4a0add68b