Node: doc: sorting in doc/api/cli?

Created on 5 Apr 2018  路  9Comments  路  Source: nodejs/node

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?

cli doc question

All 9 comments

+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.

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

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

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.)

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

@vsemozhetbyt, doc specific PR submitted.

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

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

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.

Fixed in a43e8896f2c252ef30b4da08402badbe3a17124f. Thank you all!

Was this page helpful?
0 / 5 - 0 ratings