machow / quartodoc

Generate API documentation with quarto
https://machow.github.io/quartodoc
MIT License
185 stars 21 forks source link

Have an option not to sort member items. #318

Closed has2k1 closed 1 month ago

has2k1 commented 10 months ago

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 commented 10 months ago

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

gadenbuie commented 1 month ago

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 commented 1 month ago

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