search

nodejs / node

Node.js JavaScript runtime ✨🐢🚀✨
https://nodejs.org
Other
106.71k stars 29.1k forks source link

fs documentation TOC unreadable due to lack of sorting #2258

Closed sam-github closed 9 years ago

sam-github commented 9 years ago

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 commented 9 years ago

I think there was discussion in here about this generally: https://github.com/nodejs/io.js/issues/393

thefourtheye commented 9 years ago

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 commented 9 years ago

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