Skip to content
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

Replace parens with square brackets for optional suffixes #9200

Closed
spectria-limina opened this issue Jul 18, 2023 · 1 comment · Fixed by #9223
Closed

Replace parens with square brackets for optional suffixes #9200

spectria-limina opened this issue Jul 18, 2023 · 1 comment · Fixed by #9223
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@spectria-limina
Copy link
Contributor

At the explanation of Query methods, round parens are used to explain the optional _mut suffixes. This is a bit unidiomatic; square brackets would be better.
@spectria-limina spectria-limina added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Jul 18, 2023
@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events and removed S-Needs-Triage This issue needs to be labelled labels Jul 18, 2023
@weykon
Copy link

weykon commented Jul 20, 2023

This looks like I might be able to help

ryand67 added a commit to ryand67/bevy that referenced this issue Jul 20, 2023
@ryand67
replace parens with square brackets when referencing _mut on query page
f16e774 
bevyengine#9200
@ryand67 ryand67 mentioned this issue Jul 20, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Jul 20, 2023
@ryand67
replace parens with square brackets when referencing _mut on Query …
264195e 
…docs #9200 (#9223)

# Objective

Fixes #9200 
Switches ()'s to []'s when talking about the optional `_mut` suffix in
the ECS Query Struct page to have more idiomatic docs.

## Solution

Replace `()` with `[]` in appropriate doc pages.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

replace parens with square brackets when referencing _mut on Query docs #9200 ryand67/bevy
3 participants
@alice-i-cecile @weykon @spectria-limina