Skip to content

Fix color input docs - #26071

Closed
sri443 wants to merge 1 commit into
bevyengine:mainfrom
sri443:patch-1
Closed

sri443 wants to merge 1 commit into
bevyengine:mainfrom
sri443:patch-1

Conversation

@sri443

@sri443 sri443 commented Oct 9, 2026

Copy link
Copy Markdown

Objective

Solution

  • Updated the docs to clarify that color input preferences are kept for the lifetime of the app and aren't saved between runs, even when the settings plugin is installed.

Testing

  • This is a documentation-only change, so no behavior testing was needed.
  • Reviewed the change in GitHub's diff preview.
  • Formatting and documentation checks are left to the PR's CI, as I edited the change in the browser and didn't run Cargo locally.

AI Disclosure

  • An AI assistant helped me find the relevant file and understand the code; I authored the documentation changes and this description myself in accordance with Bevy's policy.

@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide, as well as our policy regarding AI usage, and we look forward to reviewing your pull request shortly ✨

@alice-i-cecile
alice-i-cecile requested a review from viridia October 9, 2026 06:24
@viridia

viridia commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

Ah yes. I was saving this for the very last thing, or a follow-up PR, and I guess it slipped my mind.

To save the user preferences, three things have to happen:

  • The resource needs to be annotated with a SettingsGroup.
  • The app needs to have the settings plugin installed.
  • The app needs to trigger a settings save before exiting.

Note that doing this means that the app developer has no control over which TOML key is used to store the color input preferences, since it's hard-coded in the derive macro. This is probably OK.

Changing the documentation works, but you'll just have to change it back again once settings are implemented.

@sri443

sri443 commented Oct 9, 2026 •

Copy link
Copy Markdown
Author

@viridia Thanks for explaining! I thought of doing the full fix too, but figured updating the docs in the meantime would be better than leaving something misleading in there. I understand the docs would need to be updated again once the settings work is done.

Is anyone already working on the full settings fix? If not, I'm happy to take it on! Otherwise, would the docs-only change be fine to merge for now?

@viridia

viridia commented Oct 10, 2026

Copy link
Copy Markdown
Contributor

Nope, no one is working on this.

@sri443

sri443 commented Oct 10, 2026

Copy link
Copy Markdown
Author

Great! then i'll give it a try.

@sri443

sri443 commented Oct 10, 2026

Copy link
Copy Markdown
Author

@viridia I've opened a new PR with the complete fix #26099. I'll close this one. Can you take a look at it when you get the chance? Thanks!

@sri443 sri443 closed this Oct 10, 2026
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.

The docs for FeathersColorInput claim that user preferences are saved, but this is not actually implemented

2 participants