Skip to content

[Merged by Bors] - Fix doc comment "Turbo" -> "Extreme"#7091

Closed
A-Walrus wants to merge 2 commits intobevyengine:mainfrom
A-Walrus:fix_docs
Closed

[Merged by Bors] - Fix doc comment "Turbo" -> "Extreme"#7091
A-Walrus wants to merge 2 commits intobevyengine:mainfrom
A-Walrus:fix_docs

Conversation

@A-Walrus
Copy link
Contributor

@A-Walrus A-Walrus commented Jan 5, 2023

Objective

Doc comment mentions turbo which is a sensitivity that doesn't exist.

Solution

Change the comment to "Extreme" which does exist

/// Use lower sensitivity for a sharper, faster, result.
/// Use higher sensitivity for a slower, smoother, result.
/// Ultra and Turbo settings can result in significant smearing and loss of detail.
/// Ultra and Extreme settings can result in significant smearing and loss of detail.
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps these should link to their respective settings? That would help prevent such discrepancies in the future

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed 👍

@joseph-gio joseph-gio added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jan 5, 2023
@james7132 james7132 added the C-Docs An addition or correction to our documentation label Jan 5, 2023
@mockersf
Copy link
Member

mockersf commented Jan 6, 2023

bors r+

@james7132
Copy link
Member

bors retry

bors bot pushed a commit that referenced this pull request Jan 6, 2023
# Objective
Doc comment mentions turbo which is a sensitivity that doesn't exist.

## Solution

Change the comment to "Extreme" which does exist
@bors bors bot changed the title Fix doc comment "Turbo" -> "Extreme" [Merged by Bors] - Fix doc comment "Turbo" -> "Extreme" Jan 6, 2023
@bors bors bot closed this Jan 6, 2023
james7132 pushed a commit to james7132/bevy that referenced this pull request Jan 21, 2023
# Objective
Doc comment mentions turbo which is a sensitivity that doesn't exist.

## Solution

Change the comment to "Extreme" which does exist
alradish pushed a commit to alradish/bevy that referenced this pull request Jan 22, 2023
# Objective
Doc comment mentions turbo which is a sensitivity that doesn't exist.

## Solution

Change the comment to "Extreme" which does exist
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective
Doc comment mentions turbo which is a sensitivity that doesn't exist.

## Solution

Change the comment to "Extreme" which does exist
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.

6 participants