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

[Docs] Fix alphabetical order of API lists #761

Merged
merged 1 commit into from
Jan 10, 2017

Conversation

koba04
Copy link
Contributor

@koba04 koba04 commented Jan 5, 2017

I suppose these API lists are sorting as alphabetical order, aren't they?
This PR is to fix the order.

BTW, Is the following list sorting as some intentional order?

http://airbnb.io/enzyme/docs/api/shallow.html#shallowwrapper-api

Thanks.

@ljharb
Copy link
Member

ljharb commented Jan 5, 2017

I don't think either list is intended to be sorted in any particular order. I don't mind alphabetizing it, but I also don't think it matters - people will use "find in page" to find something specific, or will browse through them all.

@koba04
Copy link
Contributor Author

koba04 commented Jan 5, 2017

I think ShallowWrapper API looks good to me.

But Table of Contents is cofusing because it's almost alphabetical order, and it's not same as ShallowWrapper API.
(ex. is(selector) and isEmpty() are not adjacent)

When I write tests with enzyme, I look for a suitable API in the API list of Table of Contents.
I think it would be nice if the list is sorted as some rule.

@blainekasten
Copy link
Contributor

I am 👍 for alphabetical lists.

@blainekasten
Copy link
Contributor

can you rebase this over master so we can merge it?

@koba04
Copy link
Contributor Author

koba04 commented Jan 10, 2017

@blainekasten Thank you! Rebased!

@blainekasten blainekasten merged commit bed48af into enzymejs:master Jan 10, 2017
@blainekasten
Copy link
Contributor

Thank you @koba04 !

@koba04
Copy link
Contributor Author

koba04 commented Jan 10, 2017

Thanks!

@koba04 koba04 deleted the fix-api-docs-order branch January 10, 2017 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants