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: document "flat" util.inspect signature #23205

Closed
refack opened this issue Oct 1, 2018 · 4 comments
Closed

doc: document "flat" util.inspect signature #23205

refack opened this issue Oct 1, 2018 · 4 comments
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. util Issues and PRs related to the built-in util module.

Comments

@refack
Copy link
Contributor

refack commented Oct 1, 2018

The code allows calling it as

util.inspect(object, [showHidden], [depth], [colors])

It wash refactored 6 years ago (Refs: 07774e6) and marked legacy, but it seems it is still often used, and so should be documented.
@refack refack added util Issues and PRs related to the built-in util module. doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. labels Oct 1, 2018
@Nacen
Copy link

Nacen commented Oct 2, 2018

Hi i'm still new and i would like to contribute, do i add in the docs that you could also use the signature util.inspect(object, [showHidden], [depth], [colors]) aside from the new one?

@vsemozhetbyt vsemozhetbyt mentioned this issue Oct 2, 2018
Closed
3 tasks
@BridgeAR
Copy link
Member

BridgeAR commented Oct 2, 2018

I don't think that it is a good API signature and documenting it would go in the wrong direction.

This was referenced Oct 2, 2018
Closed
Closed
@refack
Copy link
Contributor Author

refack commented Oct 2, 2018

I don't think that it is a good API signature and documenting it would go in the wrong direction.

I think we should either deprecate or document.
From #22753 and #22751 it seems like there is no consensus for deprecation, so IMHO we need to document this.

targos pushed a commit that referenced this issue Oct 10, 2018
@siddhant1 @targos
doc: add util.inspect() legacy signature
eee71d6 
PR-URL: #23216
Fixes: #23205
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
jasnell pushed a commit that referenced this issue Oct 17, 2018
@siddhant1 @jasnell
doc: add util.inspect() legacy signature
80a86e6 
PR-URL: #23216
Fixes: #23205
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. util Issues and PRs related to the built-in util module.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@refack @BridgeAR @Nacen and others