Skip to content

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

Closed
@kpreid

Description

@kpreid

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions