Skip to content

doc: do not use & for "and" in text #39345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Trott merged 1 commit into from
Jul 12, 2021
Merged

doc: do not use & for "and" in text #39345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: do not use & for "and" in text 
This also changes a line in the man page to be sentence case.

Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/special-characters

PR-URL: #39345
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
  • Loading branch information
@Trott
Trott committed Jul 12, 2021
commit f0838a09f1857da01e73f626c7d72eb0d74f2497
2 changes: 1 addition & 1 deletion doc/guides/writing-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Add tests when:

## Test directory structure

See [directory structure overview][] for outline of existing test & locations.
See [directory structure overview][] for outline of existing test and locations.
When deciding on whether to expand an existing test file or create a new one,
consider going through the files related to the subsystem.
For example, look for `test-streams` when writing a test for `lib/streams.js`.
Expand Down
2 changes: 1 addition & 1 deletion doc/node.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,7 @@ Documentation:
.Sy https://nodejs.org/api/
.
.Pp
GitHub repository & Issue Tracker:
GitHub repository and issue tracker:
.Sy https://github.com/nodejs/node
.
.Pp
Expand Down
4 changes: 2 additions & 2 deletions onboarding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ onboarding session.

* This session will cover:
* [local setup](#local-setup)
* [project goals & values](#project-goals--values)
* [project goals and values](#project-goals-and-values)
* [managing the issue tracker](#managing-the-issue-tracker)
* [reviewing PRs](#reviewing-prs)
* [landing PRs](#landing-prs)
Expand Down Expand Up @@ -60,7 +60,7 @@ The project has two venues for real-time discussion:
* [`#nodejs-dev`](https://openjs-foundation.slack.com/archives/C019Y2T6STH) on
the [OpenJS Foundation](https://slack-invite.openjsf.org/)

## Project goals & values
## Project goals and values

* Collaborators are the collective owners of the project
* The project has the goals of its contributors
Expand Down