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.

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

Jump to bottom

doc, util, console: clarify ambiguous docs #14027

Closed
wants to merge 2 commits into from
Closed

doc, util, console: clarify ambiguous docs #14027

wants to merge 2 commits into from

Conversation

nattelog
Copy link
Contributor

@nattelog nattelog commented Jul 1, 2017

Add clarification to the documentation on util.format() and console.log()
regarding how excessive arguments are treated when the first argument is
a non-format string compared to when it is not a string at all.

Fixes: #13908

Checklist
  • make -j4 test (UNIX)
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, util, console

@nattelog
doc, util, console: clarify ambiguous docs
b687f17 
Add clarification to the documentation on util.format() and console.log()
regarding how excessive arguments are treated when the first argument is
a non-format string compared to when it is not a string at all.

Fixes: nodejs#13908
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 1, 2017
@vsemozhetbyt vsemozhetbyt added console Issues and PRs related to the console subsystem. util Issues and PRs related to the built-in util module. labels Jul 1, 2017
@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Jul 1, 2017 •
edited
Loading

Thank you!

Maybe we should note about typeof, as functions are objects, while inspect() is not called for them.

@nattelog
Copy link
Contributor Author

nattelog commented Jul 1, 2017

Of course, that's true.

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Jul 1, 2017 •
edited
Loading

And maybe we can combine the two adjacent mentions about objects and symbols so it would not be in some way surplus.

@nattelog
doc: combine mentions on excessive arguments
5f01b7b 
Rephrased how excessive arguments to the format string are concatenated.

Fixes: nodejs#13908
@vsemozhetbyt
Copy link
Contributor

cc @nodejs/documentation

vsemozhetbyt pushed a commit that referenced this pull request Jul 4, 2017
@nattelog @vsemozhetbyt
doc, util, console: clarify ambiguous docs
f2149d4 
Add clarification to the documentation on util.format()
and console.log() regarding how excessive arguments are treated
when the first argument is a non-format string
compared to when it is not a string at all.

PR-URL: #14027
Fixes: #13908
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@vsemozhetbyt
Copy link
Contributor

Landed in f2149d4

@nattelog Thank you for your contribution!

@nattelog
Copy link
Contributor Author

nattelog commented Jul 5, 2017

Awesome!

addaleax pushed a commit that referenced this pull request Jul 11, 2017
@nattelog @addaleax
doc, util, console: clarify ambiguous docs
751bb5e 
Add clarification to the documentation on util.format()
and console.log() regarding how excessive arguments are treated
when the first argument is a non-format string
compared to when it is not a string at all.

PR-URL: #14027
Fixes: #13908
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@addaleax addaleax mentioned this pull request Jul 11, 2017
Merged
addaleax pushed a commit that referenced this pull request Jul 18, 2017
@nattelog @addaleax
doc, util, console: clarify ambiguous docs
d4a6ca6 
Add clarification to the documentation on util.format()
and console.log() regarding how excessive arguments are treated
when the first argument is a non-format string
compared to when it is not a string at all.

PR-URL: #14027
Fixes: #13908
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Fishrock123 pushed a commit that referenced this pull request Jul 19, 2017
@nattelog @Fishrock123
doc, util, console: clarify ambiguous docs
1ff5aea 
Add clarification to the documentation on util.format()
and console.log() regarding how excessive arguments are treated
when the first argument is a non-format string
compared to when it is not a string at all.

PR-URL: #14027
Fixes: #13908
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Aug 15, 2017
@nattelog @MylesBorins
doc, util, console: clarify ambiguous docs
06657b1 
Add clarification to the documentation on util.format()
and console.log() regarding how excessive arguments are treated
when the first argument is a non-format string
compared to when it is not a string at all.

PR-URL: #14027
Fixes: #13908
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Aug 15, 2017
@nattelog @MylesBorins
doc, util, console: clarify ambiguous docs
95ca4ac 
Add clarification to the documentation on util.format()
and console.log() regarding how excessive arguments are treated
when the first argument is a non-format string
compared to when it is not a string at all.

PR-URL: #14027
Fixes: #13908
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Aug 15, 2017
@nattelog @MylesBorins
doc, util, console: clarify ambiguous docs
ce28385 
Add clarification to the documentation on util.format()
and console.log() regarding how excessive arguments are treated
when the first argument is a non-format string
compared to when it is not a string at all.

PR-URL: #14027
Fixes: #13908
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Aug 16, 2017
@nattelog @MylesBorins
doc, util, console: clarify ambiguous docs
7f6f1c2 
Add clarification to the documentation on util.format()
and console.log() regarding how excessive arguments are treated
when the first argument is a non-format string
compared to when it is not a string at all.

PR-URL: #14027
Fixes: #13908
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Aug 16, 2017
Merged
This was referenced Sep 5, 2017
Closed
Closed
Closed
This was referenced Sep 6, 2017
Closed
Closed
@adamlaska adamlaska mentioned this pull request May 13, 2022
Open
@snyk-bot snyk-bot mentioned this pull request Apr 27, 2023
Open
This was referenced Apr 28, 2023
Open
Open
@snyk-bot snyk-bot mentioned this pull request Apr 28, 2023
Open
This was referenced Apr 28, 2023
Open
Open
@snyk-bot snyk-bot mentioned this pull request Apr 28, 2023
Open
@aliscco aliscco mentioned this pull request Apr 28, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@fhinkel fhinkel fhinkel approved these changes

Assignees
No one assigned
Labels
console Issues and PRs related to the console subsystem. doc Issues and PRs related to the documentations. util Issues and PRs related to the built-in util module.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

console, doc, util: console.log() and util.format() are wrongly documented and may be inconsistent
7 participants
@nattelog @vsemozhetbyt @fhinkel @lpinca @cjihrig @MylesBorins @nodejs-github-bot