Skip to content

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

Description

@refack

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.

Activity

  1. added
    utilIssues and PRs related to the built-in util module.
    docIssues and PRs related to Node.js documentation.
    good first issueIssues that are suitable for first-time contributors.
    on Oct 1, 2018
  2. BridgeAR commented on Oct 2, 2018

    @BridgeAR
    Member

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

  3. refack commented on Oct 2, 2018

    @refack
    ContributorAuthor

    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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.good first issueIssues that are suitable for first-time contributors.utilIssues and PRs related to the built-in util module.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions