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

fs documentation TOC unreadable due to lack of sorting #2258

Closed
sam-github opened this issue Jul 28, 2015 · 3 comments
Closed

fs documentation TOC unreadable due to lack of sorting #2258

sam-github opened this issue Jul 28, 2015 · 3 comments
Labels
doc Issues and PRs related to the documentations. duplicate Issues and PRs that are duplicates of other issues or PRs. fs Issues and PRs related to the fs subsystem / file system.

Comments

@sam-github
Copy link
Contributor

There are small clumps of 2 or 3 functions where there is a relationship, but its overall basically random, or order of implementation, or some other useless order. I just had to do a bunch of coding against the fs API, and navigating the docs to find one method name out of screenfulls of unordered entries was extraordinarily and unnecessarily painful.

Can I alphabetize them?

@brendanashworth brendanashworth added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Jul 28, 2015
@brendanashworth
Copy link
Contributor

I think there was discussion in here about this generally: #393

@thefourtheye
Copy link
Contributor

I am finding it very difficult to browse at least the fs page and find the actual function. I always have to use the search functionality. I am +1 on this.

Also we can simply leave a general note about the async variants and explain in detail if the async version is different from general async version.

@Fishrock123 Fishrock123 added the duplicate Issues and PRs that are duplicates of other issues or PRs. label Jul 28, 2015
@Fishrock123
Copy link
Contributor

Let's move this back to #393. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. duplicate Issues and PRs that are duplicates of other issues or PRs. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

No branches or pull requests

4 participants