Skip to content

Update namespace table of contents in README.md files #449

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
merged 1 commit into from
Aug 16, 2021
Merged

Update namespace table of contents in README.md files #449

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
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/os/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@ The namespace contains a variety of OS-related utility methods:

<div class="namespace-toc">

- <span class="signature">[`BYTE_ORDER`][@stdlib/os/byte-order]</span><span class="delimiter">: </span><span class="description">platform byte order.</span>
- <span class="signature">[`configdir( [path] )`][@stdlib/os/configdir]</span><span class="delimiter">: </span><span class="description">return a directory for user-specific configuration files.</span>
- <span class="signature">[`FLOAT_WORD_ORDER`][@stdlib/os/float-word-order]</span><span class="delimiter">: </span><span class="description">platform float word order.</span>
- <span class="signature">[`homedir()`][@stdlib/os/homedir]</span><span class="delimiter">: </span><span class="description">return the current user's home directory.</span>
- <span class="signature">[`tmpdir()`][@stdlib/os/tmpdir]</span><span class="delimiter">: </span><span class="description">return the directory for storing temporary files.</span>

Expand All @@ -62,6 +60,8 @@ In addition, it exports the following constants:
<div class="namespace-toc">

- <span class="signature">[`ARCH`][@stdlib/os/arch]</span><span class="delimiter">: </span><span class="description">operating system CPU architecture.</span>
- <span class="signature">[`BYTE_ORDER`][@stdlib/os/byte-order]</span><span class="delimiter">: </span><span class="description">platform byte order.</span>
- <span class="signature">[`FLOAT_WORD_ORDER`][@stdlib/os/float-word-order]</span><span class="delimiter">: </span><span class="description">platform float word order.</span>
- <span class="signature">[`NUM_CPUS`][@stdlib/os/num-cpus]</span><span class="delimiter">: </span><span class="description">number of CPUs.</span>
- <span class="signature">[`PLATFORM`][@stdlib/os/platform]</span><span class="delimiter">: </span><span class="description">platform on which the current process is running.</span>

Expand Down Expand Up @@ -98,16 +98,16 @@ console.log( objectKeys( ns ) );

[@stdlib/os/arch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/arch

[@stdlib/os/byte-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/byte-order

[@stdlib/os/float-word-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/float-word-order

[@stdlib/os/num-cpus]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/num-cpus

[@stdlib/os/platform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/platform

[@stdlib/os/byte-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/byte-order

[@stdlib/os/configdir]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/configdir

[@stdlib/os/float-word-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/float-word-order

[@stdlib/os/homedir]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/homedir

[@stdlib/os/tmpdir]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/os/tmpdir
Expand Down