Skip to content

Enforce methods alphabetical sorting #277

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.

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

Open
araujogui opened this issue May 22, 2025 · 1 comment
Open

Enforce methods alphabetical sorting #277

araujogui opened this issue May 22, 2025 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@araujogui
Copy link
Member

araujogui commented May 22, 2025

Ensure methods within a module are listed in strict alphabetical order.

Related to nodejs/node#58402

@araujogui araujogui self-assigned this May 22, 2025
@araujogui araujogui added the enhancement New feature or request label May 22, 2025
@mureinik
Copy link

mureinik commented May 22, 2025

It's worth noting that a module's documentation doesn't just contain its methods.

Consider, e.g., the documentation for process:
It starts with the module's events (which are alphabetized).
After the events, we have the module's members (some of which are functions, some are just properties), which are alphabetized (or, at least, would be after a version containing nodejs/node#58402 fix is deployed)
After all the properties, there's a paragraph about exit codes.

Presumably, the proposed enhancement is to sort the items within each category, right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants