Skip to content

feature: members_order = '__all__' #219

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
samuelcolvin opened this issue Dec 23, 2024 · 3 comments
Closed

feature: members_order = '__all__' #219

samuelcolvin opened this issue Dec 23, 2024 · 3 comments
Assignees
Labels
feature New feature or request insiders Candidate for Insiders

Comments

@samuelcolvin
Copy link

Would be great if we could add another option to members_order to respect the order of __all__.

I think mkdocstrings already respects __all__ to include members, so I guess it shouldn't be that hard to add?

@samuelcolvin samuelcolvin added the feature New feature or request label Dec 23, 2024
@pawamoy
Copy link
Member

pawamoy commented Dec 23, 2024

We're actually very close to supporting __all__ (a few internals to refactor to officialize it) 🙂

Then yes, supporting __all__ ordering should be easy. Quick question: what happens for classes? They don't define __all__. I suppose members_order could accept a list?

members_order:
- __all__
- source

There might be more elegant ways to specify that 🤔

@samuelcolvin
Copy link
Author

List sounds fine to me.

@pawamoy pawamoy added the insiders Candidate for Insiders label Mar 20, 2025
pawamoy added a commit that referenced this issue Mar 22, 2025
@pawamoy
Copy link
Member

pawamoy commented Mar 24, 2025

@pawamoy pawamoy closed this as completed Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request insiders Candidate for Insiders
Projects
None yet
Development

No branches or pull requests

2 participants