Skip to content

Commit ca470cf

Browse files
nschonniMylesBorins
authored andcommitted
fix: remark-lint prohibited-strings (nodejs#348)
- Github -> GitHub - Javascript -> JavaScript - Delete "Note that" - node.js -> Node.js
1 parent 7794efb commit ca470cf

File tree

8 files changed

+9
-10
lines changed

8 files changed

+9
-10
lines changed

.remarkrc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
["remark-lint-no-multiple-toplevel-headings", false],
1515
["remark-lint-no-tabs", false],
1616
["remark-lint-no-trailing-spaces", false],
17-
["remark-lint-prohibited-strings", false],
1817
["remark-lint-unordered-list-marker-style", false]
1918
]
2019
}

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
The [Node.js Code of Conduct][] applies to this repo.
44

5-
[node.js code of conduct]:
5+
[Node.js code of conduct]:
66
https://github.com/nodejs/node/blob/master/CODE_OF_CONDUCT.md

ModerationPolicy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
The [Node.js Moderation Policy][] applies to this repo.
44

5-
[node.js moderation policy]:
5+
[Node.js moderation policy]:
66
https://github.com/nodejs/admin/blob/master/Moderation-Policy.md

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
109109
110110
## 📝 Data Sources
111111
112-
This repository contains no documentation content. Content is pulled from across the Node.js Github Org, Contentful, and other data sources and stitched together into a cohesive website.
112+
This repository contains no documentation content. Content is pulled from across the Node.js GitHub Org, Contentful, and other data sources and stitched together into a cohesive website.
113113
114114
### src/documentation
115115

meetings/2018-04-26.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Dropped / punted for now.
3737
- Two options here: Funds through the foundation for hiring a design firm, or community submissions.
3838
- Two-pronged approach, we will start the public call for designers now and also begin the process of requesting funds now as a backup (ETA ~3mo if needed)
3939
- Put the infrastructure in place to handle the influx of design submissions
40-
- Make this call available outside of Github
40+
- Make this call available outside of GitHub
4141
- Make Call for Proposals ready to launch by date of the Collab Summit. Launch at Collab Summit
4242

4343
#### Tech Exploration for In-Browser Node Playground [#12](https://github.com/nodejs/website-redesign/issues/12)

src/documentation/0002-node-history/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ In this post, we draw the big picture of Node.js in its history, to put things i
1919

2020
JavaScript is a programming language that was created at Netscape as a scripting tool to manipulate web pages inside their browser, [Netscape Navigator](https://en.wikipedia.org/wiki/Netscape_Navigator).
2121

22-
Part of the business model of Netscape was to sell Web Servers, which included an environment called _Netscape LiveWire_ that could create dynamic pages using server-side JavaScript. Unfortunately, _Netscape LiveWire_ wasn't very successful and server-side Javascript wasn't popularized until recently, by the introduction of Node.js.
22+
Part of the business model of Netscape was to sell Web Servers, which included an environment called _Netscape LiveWire_ that could create dynamic pages using server-side JavaScript. Unfortunately, _Netscape LiveWire_ wasn't very successful and server-side JavaScript wasn't popularized until recently, by the introduction of Node.js.
2323

2424
One key factor that led to the rise of Node.js was the timing. Just a few years earlier, JavaScript had started to be considered as a more serious language, thanks to "Web 2.0" applications (such as Flickr, Gmail, etc.) that showed the world what a modern experience on the web could be like.
2525

src/documentation/0034-javascript-promises/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ const isItDoneYet = new Promise((resolve, reject) => {
5858
})
5959
```
6060

61-
As you can see, the promise checks the `done` global constant, and if that's true, the promise goes to a **resolved** state (since the `resolve` callback was called); otherwise, the `reject` callback is executed, putting the promise in a rejected state. (Note that if one of these functions is never called in the execution path, the promise will remain in a pending state)
61+
As you can see, the promise checks the `done` global constant, and if that's true, the promise goes to a **resolved** state (since the `resolve` callback was called); otherwise, the `reject` callback is executed, putting the promise in a rejected state. (If one of these functions is never called in the execution path, the promise will remain in a pending state)
6262

6363
Using `resolve` and `reject`, we can communicate back to the caller what the resulting promise state was, and what to do with it. In the above case we just returned a string, but it could be an object, or `null` as well. Because we've created the promise in the above snippet, it has **already started executing**. This is important to understand what's going on in the section [Consuming a promise](#consuming-a-promise) below.
6464

65-
A more common example you may come across is a technique called **Promisifying**. This technique is a way to be able to use a classic javascript function that takes a callback, and have it return a promise:
65+
A more common example you may come across is a technique called **Promisifying**. This technique is a way to be able to use a classic JavaScript function that takes a callback, and have it return a promise:
6666

6767
```js
6868
const fs = require('fs')
@@ -84,7 +84,7 @@ getFile('/etc/passwd')
8484
.catch(err => console.error(err))
8585
```
8686

87-
> note that in recent versions of node.js, you won't have to do this manual conversion for a lot of the API. There is a promisifying function available in the [util module](https://nodejs.org/docs/latest-v11.x/api/util.html#util_util_promisify_original) that will do this for you, given that the function you're promisifying has the correct signature.
87+
> In recent versions of Node.js, you won't have to do this manual conversion for a lot of the API. There is a promisifying function available in the [util module](https://nodejs.org/docs/latest-v11.x/api/util.html#util_util_promisify_original) that will do this for you, given that the function you're promisifying has the correct signature.
8888
---
8989

9090
## Consuming a promise

style-guide/0001-voice-and-tone.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ to be personal and inviting. To achieve this, we may address our reader like
4949
a friend.
5050

5151
We might say: _"You're welcome to chat with us about Node.js core features on our
52-
Github issues list!"_
52+
GitHub issues list!"_
5353

5454
Instead of: _"The GitHub issues list is the place for discussion of Node.js core
5555
features."_

0 commit comments

Comments
 (0)