Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
ff55e129
Commit
ff55e129
authored
Aug 04, 2021
by
Suzanne Selhorn
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added guidance for this, these, that, those
parent
d1e2729c
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
2 deletions
+20
-2
doc/development/documentation/styleguide/word_list.md
doc/development/documentation/styleguide/word_list.md
+20
-2
No files found.
doc/development/documentation/styleguide/word_list.md
View file @
ff55e129
...
...
@@ -347,11 +347,13 @@ Use instead of **sub-group**.
## that
Do not use. For example:
Do not use
when describing a noun
. For example:
-
Avoid: The file
that
you save...
-
Avoid: The file
**that**
you save...
-
Use instead: The file you save...
See also
[
this, these, that, those
](
#this-these-that-those
)
.
## there is, there are
Try to avoid. These phrases hide the subject.
...
...
@@ -365,6 +367,22 @@ Avoid the use of gender-specific pronouns, unless referring to a specific person
Use a singular
[
they
](
https://developers.google.com/style/pronouns#gender-neutral-pronouns
)
as
a gender-neutral pronoun.
## this, these, that, those
Always follow these words with a noun. For example:
-
Avoid:
**This**
improves performance.
-
Use instead:
**This setting**
improves performance.
-
Avoid:
**These**
are the best.
-
Use instead:
**These pants**
are the best.
-
Avoid:
**That**
is the one you are looking for.
-
Use instead:
**That Jedi**
is the one you are looking for.
-
Avoid:
**Those**
need to be configured.
-
Use instead:
**Those settings**
need to be configured. (Or even better,
**Configure those settings.**
)
## to-do item
Use lowercase. (
[
Vale
](
../testing.md#vale
)
rule:
[
`ToDo.yml`
](
https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/ToDo.yml
)
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment