Skip to content

Make ComputedNode documentation clearer#24388

Merged
alice-i-cecile merged 1 commit into
bevyengine:mainfrom
amtep:computednode
May 22, 2026
Merged

Make ComputedNode documentation clearer#24388
alice-i-cecile merged 1 commit into
bevyengine:mainfrom
amtep:computednode

Conversation

@amtep
Copy link
Copy Markdown
Contributor

@amtep amtep commented May 22, 2026

Objective

The ComputedNode docs are a bit confusing to a new reader. Add more information and streamline them.

Solution

  • Linked back to Node for context.
  • Explained when exactly the values are calculated.
  • More consistency about the units used (physical pixels).
  • Resolved meaning inversion at "For example" (where it first said don't modify the fields, then gave an example of the opposite)
  • Changed 0. to "zero" because it reads easier (especially with the punctuation)
  • Removed mentions of Auto for values that are not Val.
  • Made more specific about when change detection is bypassed. (The original wording sounded like the user's updates to this field would also bypass it)

Testing

  • Did you test these changes? If so, how?

cargo doc -p bevy_ui and looked at the result

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-UI Graphical user interfaces, styles, layouts, and widgets S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels May 22, 2026
@github-project-automation github-project-automation Bot moved this to Needs SME Triage in UI May 22, 2026
@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels May 22, 2026
@alice-i-cecile alice-i-cecile added this pull request to the merge queue May 22, 2026
Merged via the queue into bevyengine:main with commit f54323d May 22, 2026
49 checks passed
@github-project-automation github-project-automation Bot moved this from Needs SME Triage to Done in UI May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-UI Graphical user interfaces, styles, layouts, and widgets C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants