Skip to content

Commit ebdf549

Browse files
committed
docs: fix requires and typo
--- 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: passed - 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 fda918b commit ebdf549

File tree

1 file changed

+3
-3
lines changed
  • lib/node_modules/@stdlib/_tools/github/user-details

1 file changed

+3
-3
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ limitations under the License.
3737
## Usage
3838

3939
```javascript
40-
var userinfo = require( 'github-user-details' );
40+
var userinfo = require( '@stdlib/_tools/github/user-details' );
4141
```
4242

4343
<a name="userinfo"></a>
@@ -171,7 +171,7 @@ The factory method accepts the same `options` as [`userinfo()`](#userinfo).
171171
<!-- eslint no-undef: "error" -->
172172

173173
```javascript
174-
var userinfo = require( 'github-user-details' );
174+
var userinfo = require( '@stdlib/_tools/github/user-details' );
175175

176176
var opts = {
177177
'usernames': [
@@ -236,7 +236,7 @@ Options:
236236

237237
- In addition to the [`token`][github-token] option, the [token][github-token] may also be specified by a [`GITHUB_TOKEN`][github-token] environment variable. The command-line option **always** takes precedence.
238238
- If a user's [details][github-user-details] are successfully resolved, the user info is written to `stdout`.
239-
- If a user's [details][github-user-details] cannot be resolved due to a downstream `error` (failure), the `username` (and its associated `error`) is written to `sterr`.
239+
- If a user's [details][github-user-details] cannot be resolved due to a downstream `error` (failure), the `username` (and its associated `error`) is written to `stderr`.
240240
- Output order is **not** guaranteed to match input order.
241241
- [Rate limit][github-rate-limit] information is written to `stderr`.
242242

0 commit comments

Comments
 (0)