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

[Merged by Bors] - Updated bevy_dylib documentation and added missing_doc warning. #3515

Closed
wants to merge 2 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Jan 1, 2022

This PR is part of the issue #3492.

Objective

  • Add and update the bevy_dylib documentation to achieve a 100% documentation coverage.
  • Add the #![warn(missing_docs)] lint to keep the documentation coverage for the future.

Solution

  • Add and update the bevy_dylib documentation.
  • Add the #![warn(missing_docs)] lint.

@github-actions github-actions bot added the S-Needs-Triage This issue needs to be labelled label Jan 1, 2022
crates/bevy_dylib/src/lib.rs Outdated Show resolved Hide resolved
@ghost ghost requested a review from bjorn3 January 1, 2022 22:33
@alice-i-cecile alice-i-cecile added C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation and removed S-Needs-Triage This issue needs to be labelled labels Jan 1, 2022
@bjorn3 bjorn3 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 2, 2022
@mockersf
Copy link
Member

mockersf commented Jan 2, 2022

bors r+

bors bot pushed a commit that referenced this pull request Jan 2, 2022
This PR is part of the issue #3492.

# Objective
- Add and update the bevy_dylib documentation to achieve a 100% documentation coverage.
- Add the #![warn(missing_docs)] lint to keep the documentation coverage for the future.

# Solution
- Add and update the bevy_dylib documentation.
- Add the #![warn(missing_docs)] lint.
@bors
Copy link
Contributor

bors bot commented Jan 2, 2022

@bors bors bot changed the title Updated bevy_dylib documentation and added missing_doc warning. [Merged by Bors] - Updated bevy_dylib documentation and added missing_doc warning. Jan 2, 2022
@bors bors bot closed this Jan 2, 2022
@ghost ghost deleted the update_bevy_dylib_doc branch August 7, 2022 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Code-Quality A section of code that is hard to understand or change 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.

3 participants