FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: document unspecified behavior for buf.write* methods by jasnell · Pull Request #5925 · nodejs/node · GitHub

/ node Public

doc: document unspecified behavior for buf.write* methods - #5925

Closed
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:buffer-write-doc
ConversationCommits (2)ChecksFiles changed
Closed

doc: document unspecified behavior for buf.write* methods#5925
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:buffer-write-doc

Conversation

jasnell commented Mar 27, 2016

Copy link
Copy Markdown
Member

Pull Request check-list

  • Is a documentation update included (if this change modifies
    existing APIs, or introduces new ones)?

Affected core subsystem(s)

doc/api/buffer.markdown

Description of change

Per #1161, when the buf.write*() methods are given anything other than what they expect, indicate that the behavior is unspecified.

Fixes: #1161

doc: document unspecified behavior for buf.write* methods
79131d7 
Per nodejs#1161, when the
buf.write*() methods are given anything other than what
they expect, indicate that the behavior is unspecified.

Fixes: nodejs#1161
jasnell added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Mar 27, 2016
benjamingr reviewed Mar 27, 2016
View reviewed changes
Comment thread doc/api/buffer.markdown Outdated
format (`writeDoubleBE()` writes big endian, `writeDoubleLE()` writes little
endian). The `value` argument must be a valid 64-bit double.
endian). The `value` argument *should* be a valid 64-bit double. Behavior is
unspecified if `value` is anything other than a 64-bit double.

benjamingr Mar 27, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Maybe undefined is better than unspecified here? we're specifying that the behavior is undefined right here. That's what most other languages do (like C++).

claudiorodriguez Apr 1, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think "Behavior is not defined" would be better, since the word "undefined" might confuse basic level english speakers into thinking undefined will get written into the buffer somehow. Though TBH "unspecified" looks fine to me.

claudiorodriguez commented Apr 1, 2016

Copy link
Copy Markdown
Contributor

LGTM though we need some more people to weigh in on the choice of word (unspecified/undefined/not defined)

jasnell force-pushed the buffer-write-doc branch from 4a3bc64 to 1aeb24f Compare April 2, 2016 03:47

jasnell commented Apr 2, 2016

Copy link
Copy Markdown
Member Author

@claudiorodriguez @benjamingr .. updated. PTAL

claudiorodriguez commented Apr 2, 2016

Copy link
Copy Markdown
Contributor

LGTM

jasnell added a commit that referenced this pull request Apr 3, 2016
doc: document unspecified behavior for buf.write* methods
64bf4b3 
Per #1161, when the
buf.write*() methods are given anything other than what
they expect, indicate that the behavior is unspecified.

Fixes: #1161
PR-URL: #5925
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>

jasnell commented Apr 3, 2016

Copy link
Copy Markdown
Member Author

Landed in 64bf4b3

jasnell closed this Apr 3, 2016
MylesBorins pushed a commit that referenced this pull request Apr 5, 2016
doc: document unspecified behavior for buf.write* methods
f879f5e 
Per #1161, when the
buf.write*() methods are given anything other than what
they expect, indicate that the behavior is unspecified.

Fixes: #1161
PR-URL: #5925
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
This was referenced Apr 5, 2016
Closed
Merged
MylesBorins pushed a commit that referenced this pull request Apr 11, 2016
doc: document unspecified behavior for buf.write* methods
f60ce10 
Per #1161, when the
buf.write*() methods are given anything other than what
they expect, indicate that the behavior is unspecified.

Fixes: #1161
PR-URL: #5925
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
MylesBorins mentioned this pull request Apr 11, 2016
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL