docs: sort class properties and methods #6893
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Properties are sorted in the order of [Inputs, Outputs, neither]. Secondary sorting done alphabetically. - Methods are sorted alphabetically. - All deprecated members are sorted to the end.
googlebot
added
the
cla: yes
jelbourn
reviewed
Sep 7, 2017
| /** Sorts methods by deprecated status and name. */ | ||
| function sortMethods(docA, docB) { | ||
| const deprecatedSort = sortByDeprecated(docA, docB); | ||
| if (!!deprecatedSort) { |
| } | ||
|
|
||
| /** Sorts properties by deprecated status, decorator, and name. */ | ||
| function sortProperties(docA, docB) { |
There was a problem hiding this comment.
Could you use the same function for properties and methods? All the checks for input/output should just return false for methods.
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On some components (ahem, select), it's really hard to parse the API's list of properties and methods. This sorts them into a, hopefully, logical order.