Skip to content

docs: improve README examples of lib/node_modules/@stdlib/constants/u… #2097

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

Closed
wants to merge 1 commit into from
Closed

docs: improve README examples of lib/node_modules/@stdlib/constants/u… #2097

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
22 changes: 17 additions & 5 deletions lib/node_modules/@stdlib/constants/unicode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,33 @@ limitations under the License.

> Unicode constants.

<section class="usage">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this removed?


## Usage

```javascript
var constants = require( '@stdlib/constants/unicode' );

// Maximum Unicode code point:
console.log( 'Maximum Unicode code point:', constants.MAX );

// Maximum Basic Multilingual Plane (BMP) code point:
console.log( 'Maximum BMP code point:', constants.MAX_BMP );
Comment on lines +29 to +34
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first code block is always the import. Please see other packages in the project.

```

#### constants
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this change made? Where else in the project do we make the API heading level 2?

## constants

Namespace containing Unicode constants.

```javascript
var ns = constants;
// returns {...}
var constants = require( '@stdlib/constants/unicode' );

function isValidBmpCharacter( char ) {
return char.codePointAt(0) <= constants.MAX_BMP;
}

// Check if a character is within the BMP:
console.log( 'Is "𝔸" a BMP character?', isValidBmpCharacter('𝔸') ); // false
console.log( 'Is "A" a BMP character?', isValidBmpCharacter('A') ); // true

```

<!-- <toc pattern="*"> -->
Expand Down