Skip to content
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

doc: alphabetize v8 module entries #35752

Open
wants to merge 1 commit into
base: master
from
Open

doc: alphabetize v8 module entries #35752

wants to merge 1 commit into from

Conversation

@Trott
Copy link
Member

@Trott Trott commented Oct 22, 2020

Alphabetize the entries in the v8 module documentation. I also made some
minor punctuation changes in two lines of text (removed a comma, and
changed a comma to a semicolon).

Checklist
Alphabetize the entries in the v8 module documentation. I also made some
minor punctuation changes in two lines of text (removed a comma, and
changed a comma to a semicolon).
@Trott
Copy link
Member Author

@Trott Trott commented Oct 22, 2020

Before (truncated):
image

After (also truncated):
image

@aduh95
aduh95 approved these changes Oct 22, 2020
Copy link
Contributor

@aduh95 aduh95 left a comment

RSLGTM

Copy link
Member

@gengjiawen gengjiawen left a comment

TBH, I think alphabetize V8.startCoverage and V8.stopCoverage not a good idea.
It became much less intuitive.

@gengjiawen
Copy link
Member

@gengjiawen gengjiawen commented Oct 22, 2020

Also serialize before deserilize.

@Trott
Copy link
Member Author

@Trott Trott commented Oct 22, 2020

TBH, I think alphabetize V8.startCoverage and V8.stopCoverage not a good idea.
It became much less intuitive.

It depends on whether one thinks of this as reference documentation, where there's a long list of things and you look up the thing you're looking for, or if it's more of a guide where each section needs to introduce the next and so on. I think it's more like the former. Not alphabetizing a list is OK when there's two or three items, but when there's 20 or 30 or 100, what the "intuitive" ordering is becomes impossible to say.

@puzpuzpuz puzpuzpuz self-requested a review Oct 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants
You can’t perform that action at this time.