Skip to content
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.

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

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

BeastMasterGrinder
Copy link

Resolves #1566 .

Description

improve README examples of constants/unicode namespace

Related Issues

No

This pull request:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

  • Read, understood, and followed the contributing guidelines.
  • Searched for existing issues and pull requests.
  • The issue name begins with RFC:

@stdlib-js/reviewers

…nicode

 I have read and understood the Code of Conduct.
 Searched for existing issues and pull requests.
 The issue name begins with RFC:.

Signed-off-by: Muhammad Farjad <86410882+BeastMasterGrinder@users.noreply.github.com>
Copy link
Contributor

@stdlib-bot stdlib-bot left a comment

Choose a reason for hiding this comment

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

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

@@ -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?

```

#### 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?

Comment on lines +29 to +34

// 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 );
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.

Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

This PR makes several changes we don't want and does not conform to existing project conventions/practices. As such, we won't be able to move this forward until changes are made.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC]: improve README examples of constants/unicode namespace
3 participants