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

Remove exported/unexported ordering override #1323

Merged
merged 3 commits into from
Jun 7, 2020

Conversation

laborg
Copy link
Contributor

@laborg laborg commented May 17, 2020

Three reasons I think this should be removed:

1) The documentation for @index states:

Order and Modules behave the same way as in @autodocs blocks and filter out docstrings that do not match one of the modules or categories specified.

which is not true due to the split introduced into exported/unexported bindings only in @autodocs.

2) The documentation contains an example which shows how to use the Private and Public field with @autodocs to create the currently implemented behaviour.

3) Offering the possibility to define an Order, but overridden it by something that is not documented is quite surprising and results in bug reports.

Fixes: #964

@mortenpi mortenpi added this to the 0.25.0 milestone Jun 6, 2020
Copy link
Member

@mortenpi mortenpi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for not reviewing earlier, but LGTM. I agree that we shouldn't be overriding the other ordering rules with an undocumented rule. It actually makes it impossible to properly sort your docstrings with at-autodocs in the case when you don't want to distinguish between exported and unexported names. And, as you say, if you do want to sort them by their export status, you can use two consecutive at-autodocs blocks.

@mortenpi mortenpi merged commit 7ff16ab into JuliaDocs:master Jun 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

@autodocs outputs wrong order for functions in compact "assignment form"
2 participants