Skip to content

Update the doc comments for UiCameraMap and UiCameraMapper. #20521

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
Merged
merged 3 commits into from
Aug 12, 2025
Merged

Update the doc comments for UiCameraMap and UiCameraMapper. #20521

merged 3 commits into from
Aug 12, 2025

Conversation

ickshonpe
Copy link
Contributor

Objective

The docs comments for UiCameraMap and UiCameraMapper are out of date and incorrectly refer to a default camera and UiTargetCamera that aren't present.

Solution

Update the doc comments

@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 X-Uncontroversial This work is generally agreed upon D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Aug 11, 2025
tychedelia
tychedelia approved these changes Aug 12, 2025
View reviewed changes
Copy link
Member

@tychedelia tychedelia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel like we should have better support for this but the docs are a good improvement!

@alice-i-cecile alice-i-cecile added 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 Aug 12, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Aug 12, 2025
Merged via the queue into bevyengine:main with commit 8fe6781 Aug 12, 2025
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

+1 more reviewer

@tychedelia tychedelia tychedelia approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
A-UI Graphical user interfaces, styles, layouts, and widgets C-Docs An addition or correction to our documentation D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it X-Uncontroversial This work is generally agreed upon
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ickshonpe @alice-i-cecile @tychedelia