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.

Sign up for GitHub

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

Jump to bottom

Documentation/Clarity: Make `Animation.isRunning` unwritable #318

Closed

MonsterDruide1 opened this issue Aug 4, 2022 · 0 comments

Assignees

Labels

MonsterDruide1 commented Aug 4, 2022

Are you refering to KDocs or GitHub Pages?
Project documentation, partly kotlin properties

In case of unclear documentation
Looking at Animation.isRunning: https://tudo-aqua.github.io/bgw/bgw-gui-kdoc/bgw-gui/tools.aqua.bgw.animation/-animation/is-running.html
It should be defined both in the documentation and in code that writing to this variable has no effect, or should even be blocked completely to avoid confusion with trying to start/stop animations using this flag manually.

Additional context
Related to this, #319 handles stopping animations (expected behaviour of this flag)

The text was updated successfully, but these errors were encountered:

MonsterDruide1 added the documentation label

MonsterDruide1 mentioned this issue

Stopping animations prematurely #319

Open

dominikmaeckel self-assigned this

dominikmaeckel closed this as completed in

bb0d027

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment