Skip to content

doc: sorting in doc/api/cli? #19814

Description

@vsemozhetbyt

Currently, both command line options and environment variables in the cli doc are not sorted alphabetically.

I am not sure if these lists use some logic or time order that has to be preserved.

Is it worth to sort them ASCII-wise?

Activity

  1. added
    questionIssues asking questions about Node.js.
    docIssues and PRs related to Node.js documentation.
    cliIssues and PRs related to the Node.js command-line interface.
    on Apr 4, 2018
  2. Trott commented on Apr 5, 2018

    @Trott
    Member

    +1 to alphabetical sorting. It's the most obvious thing to do, so let's not give people something to figure out if we don't have to.

  3. willhayslett commented on Apr 6, 2018

    @willhayslett
    Contributor

    @vsemozhetbyt are you executing on this? Can help if needed.

  4. richardlau commented on Apr 6, 2018

    @richardlau
    Member

    I think the command line options are listed in the order they appear in node --help.

  5. Trott commented on Apr 6, 2018

    @Trott
    Member

    I think the command line options are listed in the order they appear in node --help.

    Those should probably be alphabetized as well. :-D (FWIW, python --help and ls --help show alphabetized listings on my machine.)

  6. vsemozhetbyt commented on Apr 6, 2018

    @vsemozhetbyt
    ContributorAuthor

    @willhayslett If we have some consensus for this here with no objections in some days, please, feel free to make a PR.

  7. willhayslett commented on Apr 8, 2018

    @willhayslett
    Contributor

    @vsemozhetbyt, doc specific PR submitted.

    Should we also alphabetize the node --help output as well?

  8. vsemozhetbyt commented on Apr 8, 2018

    @vsemozhetbyt
    ContributorAuthor

    I think if the PR is adopted we definitely will need to sort this as well.

  9. Trott commented on Apr 8, 2018

    @Trott
    Member

    Should we also alphabetize the node --help output as well?

    Yes, I think ideally the ordering will be kept the same for both. So if we change one, we should change the other at the same time.

  10. 1 remaining item

  11. vsemozhetbyt commented on Apr 13, 2018

    @vsemozhetbyt
    ContributorAuthor

    Fixed in a43e889. Thank you all!

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

    cliIssues and PRs related to the Node.js command-line interface.docIssues and PRs related to Node.js documentation.questionIssues asking questions about Node.js.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions