Skip to content

Commit fe5c8c0

Browse files
PlaneshifterPlaneshifter
committed
Update formatting of README.md files
1 parent b0d820b commit fe5c8c0

File tree

21 files changed

+101
-30
lines changed

21 files changed

+101
-30
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ Already an expert?
431431
- Fork the repository.
432432
433433
- Clone the forked repository
434-
434+
435435
```bash
436436
$ git clone --depth=1 https://github.com/<username>/stdlib.git
437437
```

‎dist/datasets-suthaharan-multi-hop-sensor-network/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ var data = dataset();
6767

6868
## Notes
6969

70-
7170
- Humidity and temperature measurements were collected at `5` second intervals over a six hour period on July 10, 2010.
7271

7372
- Temperature is in degrees Celsius.

‎docs/editors/sublime-text/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,9 +185,9 @@ Copy the `completions/*.sublime-completions` and `snippets/*.sublime-snippet` fi
185185
```
186186
187187
- [**SublimeLinter-json**][sublime-text-sublimelinter-json]: plugin which lints [JSON][json].
188-
188+
189189
- [**SublimeLinter-shellcheck**][sublime-text-sublimelinter-shellcheck]: plugin which provides an interface to [shellcheck][shellcheck] for linting files having "Shell-Unix-Generic" syntax (aka Shell Script).
190-
190+
191191
If [shellcheck][shellcheck] was installed as a local project dependency (e.g., `make install-deps` on non-MacOS platforms per the project development guide), you need to configure [SublimeLinter3][sublime-text-sublimelinter3] to search the top-level `deps` directory for locally installed linter executables. For example, on Linux,
192192
193193
```text

‎lib/node_modules/@stdlib/_tools/github/create-token/README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ Options:
261261
```bash
262262
git config user.name
263263
```
264-
264+
265265
in the current working directory.
266266

267267
- If a `password` is **not** provided, the user will be prompted to provide a `password`.
@@ -331,11 +331,17 @@ $ DEBUG=* GITHUB_USERNAME=<username> GITHUB_PASSWORD=<password> ghcreatetoken --
331331
[unix-time]: http://en.wikipedia.org/wiki/Unix_time
332332

333333
[github-token]: https://github.com/settings/tokens/new
334+
334335
[github-oauth2]: https://developer.github.com/v3/#oauth2-token-sent-in-a-header
336+
335337
[github-user-agent]: https://developer.github.com/v3/#user-agent-required
338+
336339
[github-rate-limit]: https://developer.github.com/v3/rate_limit/
340+
337341
[github-create-token]: https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
342+
338343
[github-two-factor]: https://help.github.com/articles/about-two-factor-authentication/
344+
339345
[github-scopes]: https://developer.github.com/v3/oauth/#scopes
340346

341347
</section>

‎lib/node_modules/@stdlib/_tools/github/delete-token/README.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ Options:
219219
```bash
220220
git config user.name
221221
```
222-
222+
223223
in the current working directory.
224224

225225
- If a `password` is **not** provided, the user will be prompted to provide a `password`.
@@ -287,10 +287,15 @@ $ DEBUG=* GITHUB_USERNAME=<username> GITHUB_PASSWORD=<password> ghdeletetoken 12
287287
[unix-time]: http://en.wikipedia.org/wiki/Unix_time
288288

289289
[github-token]: https://github.com/settings/tokens/new
290+
290291
[github-oauth2]: https://developer.github.com/v3/#oauth2-token-sent-in-a-header
292+
291293
[github-user-agent]: https://developer.github.com/v3/#user-agent-required
294+
292295
[github-rate-limit]: https://developer.github.com/v3/rate_limit/
296+
293297
[github-delete-token]: https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
298+
294299
[github-two-factor]: https://help.github.com/articles/about-two-factor-authentication/
295300

296301
</section>

‎lib/node_modules/@stdlib/_tools/github/fetch-file/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ function clbk( error, results ) {
8585
}
8686
```
8787

88-
8988
#### fetchFile.factory( filepath, repos, clbk )
9089

9190
Creates a reusable `function`.

‎lib/node_modules/@stdlib/_tools/github/followers/README.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,6 @@ function onFollowers( error, results, info ) {
190190

191191
**Note**: in order to run the example, you will need to obtain an access [token][github-token] and modify the `token` option accordingly.
192192

193-
194193
</section>
195194

196195
<!-- /.examples -->
@@ -209,7 +208,7 @@ function onFollowers( error, results, info ) {
209208

210209
### Usage
211210

212-
``` bash
211+
```bash
213212
Usage: ghfollowers [options]
214213

215214
Options:
@@ -247,14 +246,14 @@ Options:
247246

248247
Setting the access [token][github-token] using the command-line option:
249248

250-
``` bash
249+
```bash
251250
$ DEBUG=* ghfollowers --token <token> --username 'kgryte'
252251
# => '[{...},{...},...]'
253252
```
254253

255254
Setting the access [token][github-token] using an environment variable:
256255

257-
``` bash
256+
```bash
258257
$ DEBUG=* GITHUB_TOKEN=<token> ghfollowers --username 'kgryte'
259258
# => '[{...},{...},...]'
260259
```
@@ -290,10 +289,15 @@ $ DEBUG=* GITHUB_TOKEN=<token> ghfollowers --username 'kgryte'
290289
[unix-time]: http://en.wikipedia.org/wiki/Unix_time
291290

292291
[github-get]: https://github.com/kgryte/github-get
292+
293293
[github-followers]: https://developer.github.com/v3/users/followers/
294+
294295
[github-token]: https://github.com/settings/tokens/new
296+
295297
[github-oauth2]: https://developer.github.com/v3/#oauth2-token-sent-in-a-header
298+
296299
[github-user-agent]: https://developer.github.com/v3/#user-agent-required
300+
297301
[github-rate-limit]: https://developer.github.com/v3/rate_limit/
298302

299303
</section>

‎lib/node_modules/@stdlib/_tools/github/following/README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ var opts = {
112112
following( opts, clbk );
113113
```
114114

115-
116115
#### following.factory( options, clbk )
117116

118117
Creates a reusable `function`.
@@ -292,10 +291,15 @@ $ DEBUG=* GITHUB_TOKEN=<token> ghfollowing --username 'kgryte'
292291
[unix-time]: http://en.wikipedia.org/wiki/Unix_time
293292

294293
[github-get]: https://github.com/kgryte/github-get
294+
295295
[github-following]: https://developer.github.com/v3/users/followers/
296+
296297
[github-token]: https://github.com/settings/tokens/new
298+
297299
[github-oauth2]: https://developer.github.com/v3/#oauth2-token-sent-in-a-header
300+
298301
[github-user-agent]: https://developer.github.com/v3/#user-agent-required
302+
299303
[github-rate-limit]: https://developer.github.com/v3/rate_limit/
300304

301305
</section>

‎lib/node_modules/@stdlib/_tools/github/org-repos/README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,6 @@ var opts = {
116116
repos( opts, clbk );
117117
```
118118

119-
120119
#### repos.factory( options, clbk )
121120

122121
Creates a reusable `function`.
@@ -289,10 +288,15 @@ $ DEBUG=* GITHUB_TOKEN=<token> ghorgrepos --org 'stdlib-js'
289288
[unix-time]: http://en.wikipedia.org/wiki/Unix_time
290289

291290
[github-repos]: https://developer.github.com/v3/repos/
291+
292292
[github-org-repos]: https://developer.github.com/v3/repos/#list-organization-repositories
293+
293294
[github-token]: https://github.com/settings/tokens/new
295+
294296
[github-oauth2]: https://developer.github.com/v3/#oauth2-token-sent-in-a-header
297+
295298
[github-user-agent]: https://developer.github.com/v3/#user-agent-required
299+
296300
[github-rate-limit]: https://developer.github.com/v3/rate_limit/
297301

298302
</section>

‎lib/node_modules/@stdlib/_tools/github/rank-followers/README.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ limitations under the License.
3636

3737
## Usage
3838

39-
``` javascript
39+
```javascript
4040
var rank = require( '@stdlib/_tools/github/rank-followers' );
4141
```
4242

@@ -272,7 +272,6 @@ Options:
272272

273273
- [Rate limit][github-rate-limit] information is written to `stderr`.
274274

275-
276275
</section>
277276

278277
<!-- /.notes -->
@@ -347,15 +346,23 @@ $ DEBUG=* ghrankfollowers --token <token> --username kgryte --format json
347346
<section class="links">
348347

349348
[unix-time]: http://en.wikipedia.org/wiki/Unix_time
349+
350350
[csv]: https://en.wikipedia.org/wiki/Comma-separated_values
351+
351352
[json]: http://www.json.org/
352353

353354
[github-followers]: https://github.com/kgryte/github-followers
355+
354356
[github-user-details]: https://github.com/kgryte/github-user-details
357+
355358
[github-rank-users]: https://github.com/kgryte/github-rank-users
359+
356360
[github-token]: https://github.com/settings/tokens/new
361+
357362
[github-oauth2]: https://developer.github.com/v3/#oauth2-token-sent-in-a-header
363+
358364
[github-user-agent]: https://developer.github.com/v3/#user-agent-required
365+
359366
[github-rate-limit]: https://developer.github.com/v3/rate_limit/
360367

361368
</section>

0 commit comments

Comments
 (0)