Skip to content

doc: add initial constants module documentation #6505

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
jasnell wants to merge 3 commits into from
Closed

doc: add initial constants module documentation #6505

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c5f62b
doc: add initial constants module documentation
jasnell May 1, 2016
2f4c105
Address nits
jasnell May 1, 2016
b17c2af
Address nits
jasnell May 1, 2016
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
Prev Previous commit
Next Next commit
Address nits
  • Loading branch information
@jasnell
jasnell committed May 1, 2016
commit 2f4c1054c829ba32ad798e7e7ecb33bedd30b4b3
6 changes: 3 additions & 3 deletions doc/api/constants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ exposed by the `constants` module itself.

## Error Constants

The following error constants are adapted directly from the Posix errno
The following error constants are adapted directly from the Posix `errno`
standards. See http://man7.org/linux/man-pages/man3/errno.3.html for more
Copy link
Copy Markdown
Member

@addaleax addaleax May 1, 2016

Choose a reason for hiding this comment

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

… You are fast addressing nits. 😄

The docs usually stylize it as POSIX, and manpage references like errno(3) would automatically be converted to the man7.org link.

And btw, for some of these errors, there’s already information in errno.md… not sure what to do about that (or if there’s something to be done about it), but some kind of cross-referencing might be nice.

Copy link
Copy Markdown
Member Author

@jasnell jasnell May 1, 2016

Choose a reason for hiding this comment

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

Yep, haven't gotten that far ;-) For most of these, the auto man page links should work (just need to go through and do the tedious work of adding those in. I'm open to suggestions on what to do with reconciling against errno.md.

details about specific error constants.
Copy link
Copy Markdown
Contributor

@Fishrock123 Fishrock123 May 2, 2016

Choose a reason for hiding this comment

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

Link to the Errors documentation page maybe?

Copy link
Copy Markdown
Member Author

@jasnell jasnell May 2, 2016

Choose a reason for hiding this comment

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

Can, but those are far from complete. We should either fill those out there more or move that detail into here. How those are documented leaves much to be desired.


Expand Down Expand Up @@ -1070,13 +1070,13 @@ Limit engine usage to PKEY_ASN1_METHS
#### constants.RSA_PKCS1_PSS_PADDING
#### constants.POINT_CONVERSION_COMPRESSED
#### constants.POINT_CONVERSION_UNCOMPRESSED
3### constants.POINT_CONVERSION_HYBRID
#### constants.POINT_CONVERSION_HYBRID

### Node.js Crypto Constants

#### constants.defaultCoreCipherList

Specifies the built in default cipher list used by Node.js
Specifies the built in default cipher list used by Node.js.

#### constants.defaultCipherList

Expand Down