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] - Added missing docs to bevy_internal and added warn on missing docs #3514

Closed
wants to merge 4 commits into from
Closed

[Merged by Bors] - Added missing docs to bevy_internal and added warn on missing docs #3514

wants to merge 4 commits into from

Conversation

Sheepyhead
Copy link
Contributor

Objective

This contributes documentation that should cover the entirety of bevy_internal as requested in #3492

Solution

warn(missing_docs) has been activated and documentation has been added to missing parts so that no warnings appear from this setting

@github-actions github-actions bot added the S-Needs-Triage This issue needs to be labelled label Jan 1, 2022
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation and removed S-Needs-Triage This issue needs to be labelled labels Jan 1, 2022
@alice-i-cecile alice-i-cecile 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 1, 2022
@alice-i-cecile
Copy link
Member

Extremely complex code, impeccable documented. Thanks! @mockersf, feel free to merge this one ASAP.

@alice-i-cecile alice-i-cecile removed 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 1, 2022
@alice-i-cecile
Copy link
Member

As discussed on Discord, we should have a module level doc comment that explains that this is seperate from the bevy crate to ensure that dynamic linking works correctly.

@alice-i-cecile alice-i-cecile mentioned this pull request Jan 1, 2022
Open
45 tasks
@Sheepyhead
Copy link
Contributor Author

As discussed on Discord, we should have a module level doc comment that explains that this is seperate from the bevy crate to ensure that dynamic linking works correctly.

I added a line mentioning this, if a more in depth explanation is necessary I need someone who actually understands why this separation is necessary to help me writing it

@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Jan 1, 2022
Added missing docs to bevy_internal and added warn on missing docs (#…
5c590b0 
…3514)

# Objective
This contributes documentation that should cover the entirety of bevy_internal as requested in #3492 

## Solution
warn(missing_docs) has been activated and documentation has been added to missing parts so that no warnings appear from this setting
@bors
Copy link
Contributor

bors bot commented Jan 1, 2022

Pull request successfully merged into main.

Build succeeded!

And happy new year! 🎉

@bors bors bot changed the title Added missing docs to bevy_internal and added warn on missing docs [Merged by Bors] - Added missing docs to bevy_internal and added warn on missing docs Jan 1, 2022
@bors bors bot closed this Jan 1, 2022
@Sheepyhead Sheepyhead deleted the doc/bevy_internal branch January 1, 2022 22:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bjorn3 bjorn3 bjorn3 left review comments

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
C-Docs An addition or correction to our documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Sheepyhead @alice-i-cecile @bjorn3