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

[Merged by Bors] - Fix OwningPtr docs #5391

Closed
wants to merge 1 commit into from
Closed

[Merged by Bors] - Fix OwningPtr docs #5391

wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented Jul 20, 2022

Objective

  • Fix some small errors in the documentation of the OwningPtr struct.

Solution

  • Change comments with 4 slashes //// to doc comments with 3 slashes ///.
  • Fix typos.

@mockersf mockersf 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 Jul 20, 2022
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Jul 20, 2022
Fix OwningPtr docs (#5391)
222f2dd 
# Objective

- Fix some small errors in the documentation of the `OwningPtr` struct.

## Solution

- Change comments with 4 slashes `////` to doc comments with 3 slashes `///`.
- Fix typos.
@alice-i-cecile
Copy link
Member

Filing some clippy lint requests:

  1. Lint for 4 / (////) to help detect broken doc comments rust-lang/rust-clippy#9212
  2. Suspicious comment (//) adjacent to doc comment (///) rust-lang/rust-clippy#9213

@bors
Copy link
Contributor

bors bot commented Jul 20, 2022

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title Fix OwningPtr docs [Merged by Bors] - Fix OwningPtr docs Jul 20, 2022
@bors bors bot closed this Jul 20, 2022
@ghost ghost deleted the fix_owning_ptr_docs branch August 7, 2022 08:27
inodentry pushed a commit to IyesGames/bevy that referenced this pull request Aug 8, 2022
@inodentry
Fix OwningPtr docs (bevyengine#5391)
880427d 
# Objective

- Fix some small errors in the documentation of the `OwningPtr` struct.

## Solution

- Change comments with 4 slashes `////` to doc comments with 3 slashes `///`.
- Fix typos.
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
@james7132
Fix OwningPtr docs (bevyengine#5391)
7e74d4e 
# Objective

- Fix some small errors in the documentation of the `OwningPtr` struct.

## Solution

- Change comments with 4 slashes `////` to doc comments with 3 slashes `///`.
- Fix typos.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
@ItsDoot
Fix OwningPtr docs (bevyengine#5391)
299ced1 
# Objective

- Fix some small errors in the documentation of the `OwningPtr` struct.

## Solution

- Change comments with 4 slashes `////` to doc comments with 3 slashes `///`.
- Fix typos.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@alice-i-cecile @CGMossa @mockersf @jakobhellermann