Skip to content

docs: Simplify autoclass in docs#653

Merged
ValerianRey merged 2 commits intomainfrom
simplify-autoclass-in-docs
Apr 16, 2026
Merged

docs: Simplify autoclass in docs#653
ValerianRey merged 2 commits intomainfrom
simplify-autoclass-in-docs

Conversation

@ValerianRey
Copy link
Copy Markdown
Contributor

The idea here is to stop using a bare :members: (that asks to document every member) and then opt out members that we don't want to appear, and instead add :member: with only members that we want to appear. So this doesn't change anything but makes things easier to maintain (do not have to opt out for every little member that no one should care about).

In a future PR I'll add __call__ to :members: so that we can also have a doc entry for this very important function.

@ValerianRey ValerianRey requested a review from a team as a code owner April 16, 2026 15:44
@ValerianRey ValerianRey added the cc: docs Conventional commit type for changes to the documentation. label Apr 16, 2026
@ValerianRey ValerianRey self-assigned this Apr 16, 2026
@github-actions github-actions bot changed the title Simplify autoclass in docs docs: Simplify autoclass in docs Apr 16, 2026
@ValerianRey
Copy link
Copy Markdown
Contributor Author

Merging without review because this doesn't change anything in the built docs.

@ValerianRey
Copy link
Copy Markdown
Contributor Author

@PierreQuinton Note that we will have to think about adding :members: reset for every stateful aggregator, including random ones when you change them.

@ValerianRey ValerianRey enabled auto-merge (squash) April 16, 2026 15:46
@ValerianRey ValerianRey merged commit d1d12c9 into main Apr 16, 2026
25 of 28 checks passed
@ValerianRey ValerianRey deleted the simplify-autoclass-in-docs branch April 16, 2026 15:51
@ValerianRey ValerianRey mentioned this pull request Apr 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cc: docs Conventional commit type for changes to the documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant