Skip to content

doc: should object parameter properties be sorted? #22874

Description

@vsemozhetbyt

Refs: #22824 (comment)

Pros:

  1. They will be easier to find in long lists.

Cons:

  1. Huge doc churn, git blame ruin, difficult diffs to review in correction PRs, significant backporting burdens.
  2. Hard to maintain in new PRs except it will be automated as doc lint rule.
  3. Some properties can be grouped logically, this grouping will be destroyed by ABC-sorting.

Please, vote:

+1 — 👍
-1 — 👎

Apart from the previous voting:

"I may be ready to review such PRs (one per doc to reduce the workload)" — 🎉

Activity

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

    discussIssues opened for discussion and feedback.docIssues and PRs related to Node.js documentation.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions