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.

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

docs(bevy_render): Remove copy-pasted docstring #8479

Merged
merged 1 commit into from
Apr 24, 2023

Conversation

Estus-Dev
Copy link
Contributor

This line does not appear to be an intended part of the Panics section, but instead looks like it was missed when copy-pasting a Panics section from above.

It confused me when I was reading the docs. At first I read it as if it was an imperative statement saying not to use match statements which seemed odd and out of place. Once I saw the code it was clearly in err.

Objective

  • Cleanup documentation string to reduce end-user confusion.

This line does not appear to be an intended part of the Panics section,
but instead looks like it was missed when copy-pasting a Panics section
from above.

It confused me when I was reading the docs. At first I read it as if it
was an imperative statement saying not to use `match` statements which
seemed odd and out of place.  Once I saw the code it was clearly in err.
@github-actions
Copy link
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Apr 24, 2023
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Apr 24, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 24, 2023
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Apr 24, 2023
Merged via the queue into bevyengine:main with commit a4323d5 Apr 24, 2023
@Estus-Dev Estus-Dev deleted the remove_copy_pasted_doc branch April 24, 2023 01:21
@Estus-Dev Estus-Dev restored the remove_copy_pasted_doc branch July 10, 2023 23:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants