forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

remove a doc(hidden) on read only version of derive(WorldQuery) (#6877)

Browse Source 
having `doc(hidden)` on the read only version of a generated mutable world query leads to docs on the readonly item having a dead link. It also makes it annoying to have nice docs for libraries attempting to expose derived `WorldQuery` structs as re-exporting the read only item does not cause it to appear in docs even though it would be intended for users to know about the read only world query and use it.
This commit is contained in:
Boxy 2022-12-07 23:10:26 +00:00
parent e08701307b
commit bac0d89059
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/bevy_ecs/macros/src/fetch.rs
View File

@ -333,10 +333,9 @@ pub fn derive_world_query_impl(ast: DeriveInput) -> TokenStream {
let readonly_impl = if fetch_struct_attributes.is_mutable { let readonly_impl = if fetch_struct_attributes.is_mutable {
let world_query_impl = impl_fetch(true); let world_query_impl = impl_fetch(true);
quote! { quote! {
#[doc(hidden)] #[doc = "Automatically generated [`WorldQuery`] type for a read-only variant of [`"]
#[doc = "Automatically generated internal [`WorldQuery`] type for [`"]
#[doc = stringify!(#struct_name)] #[doc = stringify!(#struct_name)]
#[doc = "`], used for read-only access."] #[doc = "`]."]
#[automatically_derived] #[automatically_derived]
#visibility struct #read_only_struct_name #user_impl_generics #user_where_clauses { #visibility struct #read_only_struct_name #user_impl_generics #user_where_clauses {
#( #field_idents: #read_only_field_types, )* #( #field_idents: #read_only_field_types, )*