Skip to content

Move State out of AcitivityIndicator#202

Merged
FichteFoll merged 1 commit intomasterfrom
bugfix/state-docs
Feb 21, 2026
Merged

Move State out of AcitivityIndicator#202
FichteFoll merged 1 commit intomasterfrom
bugfix/state-docs

Conversation

@FichteFoll
Copy link
Member

It was polluting the documentation.

image

@FichteFoll FichteFoll added this to the 2.2.0 milestone Feb 20, 2026
@deathaxe
Copy link
Member

More a Sphinx shortcomming, than a technical limitation/violation of the implementation. _State feels somewhat too generic when used as a global. And it is not more or less private that ViewTarget classes, thus probably not worth messing with underscores, as only ActivityIndicator is marked exported anyway.

@FichteFoll
Copy link
Member Author

It is sufficiently namespaced by the module imo (there is no other "state" to be had for an activity indicator). Even inside the other class, it should have been written with an underscore because it is not part of the public API, in which case it most likely also would not be picked up by sphinx's autodoc, so I would argue this is a feature working as intended and not a shortcoming.

However, I still feel that using State.STOPPED is more ergonomic than self._State.STOPPED.

It was polluting the documentation.
@FichteFoll FichteFoll merged commit 1258e99 into master Feb 21, 2026
1 check passed
@FichteFoll FichteFoll deleted the bugfix/state-docs branch February 21, 2026 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants