Skip to content

Commit fda918b

Browse files
committed
docs: fix section structure and lint errors in READMEs
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 3024bb3 commit fda918b

File tree

2 files changed

+18
-4
lines changed
  • lib/node_modules/@stdlib

2 files changed

+18
-4
lines changed

lib/node_modules/@stdlib/_tools/github/user-details/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ The `function` accepts the following `options`:
9595

9696
To [authenticate][github-oauth2] with GitHub, set the [`token`][github-token] option.
9797

98+
<!-- eslint-disable @cspell/spellchecker -->
99+
98100
```javascript
99101
var opts = {
100102
'usernames': ['kgryte'],
@@ -119,6 +121,8 @@ userinfo( opts, clbk );
119121

120122
Creates a reusable `function`.
121123

124+
<!-- eslint-disable @cspell/spellchecker -->
125+
122126
```javascript
123127
var opts = {
124128
'usernames': [ 'kgryte', 'Planeshifter' ],
@@ -135,6 +139,14 @@ get();
135139

136140
The factory method accepts the same `options` as [`userinfo()`](#userinfo).
137141

142+
</section>
143+
144+
<!-- /.usage -->
145+
146+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
147+
148+
<section class="notes">
149+
138150
## Notes
139151

140152
- If the module encounters an application-level `error` (e.g., no network connection, etc), that `error` is returned immediately to the provided `callback`.

lib/node_modules/@stdlib/error/tools/fmtprodmsg/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,11 @@ Formats an error message for production.
3636

3737
```javascript
3838
var msg = fmtprodmsg( '27', 'foo', 'bar' );
39-
// returns 'https://stdlib.io/e/27?arg[]=foo&arg[]=bar'
39+
// returns 'https://stdlib.io/e/27?&arg[]=foo&arg[]=bar'
4040
```
4141

42+
</section>
43+
4244
<!-- /.usage -->
4345

4446
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
@@ -61,13 +63,13 @@ var msg = fmtprodmsg( '27', 'foo', 'bar' );
6163
var fmtprodmsg = require( '@stdlib/error/tools/fmtprodmsg' );
6264

6365
var msg = fmtprodmsg( '3', 'foo' );
64-
// returns 'https://stdlib.io/e?code=3&arg[]=foo'
66+
// returns 'https://stdlib.io/e/3?&arg[]=foo'
6567

6668
msg = fmtprodmsg( '5', 'foo', 'bar' );
67-
// returns 'https://stdlib.io/e/5?arg[]=foo&arg[]=bar'
69+
// returns 'https://stdlib.io/e/5?&arg[]=foo&arg[]=bar'
6870

6971
msg = fmtprodmsg( '5', 'foo', 'bar', 123 );
70-
// returns 'https://stdlib.io/e/5?arg[]=foo&arg[]=bar&arg[]=123'
72+
// returns 'https://stdlib.io/e/5?&arg[]=foo&arg[]=bar&arg[]=123'
7173
```
7274

7375
</section>

0 commit comments

Comments
 (0)