Skip to content

What is the order? #332

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

Closed
khrome83 opened this issue Jan 16, 2016 · 1 comment
Closed

What is the order? #332

khrome83 opened this issue Jan 16, 2016 · 1 comment

Comments

@khrome83
Copy link

Without adding a configuration to sort, which I think is what I understood, what is the order of API output as markdown?

In other words, is it alphabetized?

It appears like it is, but I see it keep resetting. At the top of my file, I have 5 methods, then it starts the alphabet over with a different set for a large number, then I see that it does it again at the bottom.

So it is not based on bringing in a different file.

Also it does not appear to group the methods by file in any way. Writing a node module, I would expect that there would be some sort of grouping related to the source file, if we can "assume" the source file is representing a class or some other meaningful construct.

Sorry, I am fairly new to generating documentation, so just trying to wrap my head around this.

@tmcw
Copy link
Member

tmcw commented Feb 15, 2016

Yes, it's sorted - here's the file that does the sorting. There may be a defect in that code, or if you have any identically-named methods, JavaScript's sorting isn't always stable, so it could just be JS.

rhendric pushed a commit to rhendric/documentation that referenced this issue Sep 15, 2022
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

No branches or pull requests

3 participants