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

Have an option not to sort member items. #318

Closed
has2k1 opened this issue Dec 29, 2023 · 3 comments
Closed

Have an option not to sort member items. #318

has2k1 opened this issue Dec 29, 2023 · 3 comments
Assignees
Labels
time:short Takes an hour or less to resolve

Comments

@has2k1
Copy link
Contributor

has2k1 commented Dec 29, 2023

Members (when included) of classes and modules are automatically sorted. We should have an option to turn this off. Members especially Attributes can depend on prior members where the order in which they are declared in code matters and therefore it should be preserved in the documentation.

@machow machow self-assigned this Jan 19, 2024
@machow
Copy link
Owner

machow commented Jan 19, 2024

Thanks for flagging--this makes a lot of sense!

@machow machow added the time:short Takes an hour or less to resolve label Aug 21, 2024
@gadenbuie
Copy link

I'll second this; sometimes the order doesn't matter technically but is useful when documenting the class. In my case, it's much easier to understand the class fields when they're grouped together, which is broken by alphabetical sorting.

@machow
Copy link
Owner

machow commented Oct 11, 2024

Should be resolved by #373, and in the v0.8.0 release!

@machow machow closed this as completed Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
time:short Takes an hour or less to resolve
Projects
Status: Done
Development

No branches or pull requests

3 participants