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

bevy_reflect: Add crate level functions feature docs #15086

Merged

Conversation

nixpulvis
Copy link
Contributor

Adds the missing section for the functions cargo feature of the bevy_reflect crate.

@nixpulvis
Copy link
Contributor Author

@MrGVSV perhaps you have a solution to the issue currently here. I've linked to the relevant module docs and types within the func module, however, since they will not be present without the feature, this will lead to broken links.

Do you have thoughts on how to make this more discoverable, especially on sites like docs.rs, which don't compile with features enabled?

@MrGVSV
Copy link
Member

MrGVSV commented Sep 8, 2024

@MrGVSV perhaps you have a solution to the issue currently here. I've linked to the relevant module docs and types within the func module, however, since they will not be present without the feature, this will lead to broken links.

Do you have thoughts on how to make this more discoverable, especially on sites like docs.rs, which don't compile with features enabled?

Pretty sure bevy_reflect builds with all features enabled, so it shouldn't be an issue.

I think the CI error is related to referencing DynamicClosure, which no longer exists.

@TrialDragon TrialDragon added C-Docs An addition or correction to our documentation A-Reflection Runtime information about types D-Straightforward Simple bug fixes and API improvements, docs, test and examples labels Sep 8, 2024
@alice-i-cecile alice-i-cecile added the S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged label Sep 8, 2024
@MrGVSV MrGVSV added this to the 0.15 milestone Sep 28, 2024
@alice-i-cecile alice-i-cecile removed this from the 0.15 milestone Oct 8, 2024
@alice-i-cecile
Copy link
Member

Happy to merge this in 0.15 if it's ready, but I'm not comfortable blocking the release on it :) Le me know if you need a hand!

@nixpulvis
Copy link
Contributor Author

Oh totally forgot about this. I’m out tonight, but I’ll look back it this tomorrow.

@nixpulvis nixpulvis force-pushed the bevy_reflect-functions-feature-docs branch 2 times, most recently from 45b36c6 to 840fb04 Compare October 9, 2024 17:17
@nixpulvis nixpulvis force-pushed the bevy_reflect-functions-feature-docs branch from 840fb04 to cba60eb Compare October 9, 2024 17:17
@nixpulvis nixpulvis marked this pull request as ready for review October 9, 2024 17:18
@alice-i-cecile alice-i-cecile added S-Needs-Review Needs reviewer attention (from anyone!) to move forward and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Oct 9, 2024
@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 9, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 9, 2024
Merged via the queue into bevyengine:main with commit 0b2e0cf Oct 9, 2024
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Reflection Runtime information about types C-Docs An addition or correction to our documentation D-Straightforward Simple bug fixes and API improvements, docs, test and examples 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.

4 participants