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

Reexports of wgpu-core and wgpu-hal make documentation search full of noise #5669

Closed
kpreid opened this issue May 5, 2024 · 2 comments · Fixed by #5682
Closed

Reexports of wgpu-core and wgpu-hal make documentation search full of noise #5669

kpreid opened this issue May 5, 2024 · 2 comments · Fixed by #5682

Comments

@kpreid
Copy link
Contributor

kpreid commented May 5, 2024

Repro steps

  1. Go to https://docs.rs/wgpu/latest/wgpu/?search=render_pass
  2. Try to find the items relevant to actually using render passes.

Expected vs observed behavior
Formerly, this would be a reasonably short and useful list, containing

  • wgpu::CommandEncoder::begin_render_pass
  • wgpu::RenderPass

Now, it contains 40 results, 38 of which are from wgpu_core and wgpu_hal, therefore irrelevant to typical wgpu users, and the wgpu entries are not even sorted to the top.

I notice the re-exports have #[doc(inline)] on them. Perhaps removing that would fix this.

@cwfitzgerald
Copy link
Member

Agree this is a problem - will see if removing the inline helps.

@cwfitzgerald
Copy link
Member

Yup, fixes it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants