Skip to content

docs.rs documentation broken #564

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

Closed
Luro02 opened this issue Apr 8, 2020 · 4 comments
Closed

docs.rs documentation broken #564

Luro02 opened this issue Apr 8, 2020 · 4 comments
Labels
help required We need community help to make this happen. type: bug Something isn't working

Comments

@Luro02
Copy link

Luro02 commented Apr 8, 2020

https://docs.rs/crate/wgpu/0.5.0

build log:

https://docs.rs/crate/wgpu/0.5.0/builds/237075

@kvark
Copy link
Member

kvark commented Apr 8, 2020

Also see gfx-rs/wgpu-rs#244
Looks like this is blocked on rust :(

@kvark kvark added type: bug Something isn't working help required We need community help to make this happen. labels Apr 8, 2020
@aloucks
Copy link
Contributor

aloucks commented Apr 8, 2020

The docs weren't updated when the functions were renamed:

[INFO] [stderr]      |
[INFO] [stderr] 1475 |     /// The active vertex buffers can be set with [`RenderPass::set_vertex_buffers`].
[INFO] [stderr]      |                                                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
[INFO] [stderr]      |
[INFO] [stderr]      = note: `#[warn(intra_doc_link_resolution_failure)]` on by default
[INFO] [stderr]      = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: `[RenderPass::set_vertex_buffers]` cannot be resolved, ignoring it.
[INFO] [stderr]     --> src/lib.rs:1491:41
[INFO] [stderr]      |
[INFO] [stderr] 1491 |     /// vertex buffers can be set with [`RenderPass::set_vertex_buffers`].
[INFO] [stderr]      |                                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
[INFO] [stderr]      |
[INFO] [stderr]      = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: `[RenderPass::set_vertex_buffers]` cannot be resolved, ignoring it.
[INFO] [stderr]     --> src/lib.rs:1507:52
[INFO] [stderr]      |
[INFO] [stderr] 1507 |     /// The active vertex buffers can be set with [`RenderPass::set_vertex_buffers`].
[INFO] [stderr]      |                                                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
[INFO] [stderr]      |
[INFO] [stderr]      = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: `[RenderPass::set_vertex_buffers]` cannot be resolved, ignoring it.
[INFO] [stderr]     --> src/lib.rs:1522:41
[INFO] [stderr]      |
[INFO] [stderr] 1522 |     /// vertex buffers can be set with [`RenderPass::set_vertex_buffers`].
[INFO] [stderr]      |                                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
[INFO] [stderr]      |
[INFO] [stderr]      = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] thread 'rustc' panicked at 'could not find markdown in source', src/librustdoc/passes/mod.rs:411:31
[INFO] [stderr] note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
[INFO] [stderr] error: Could not document `wgpu`.

@kvark
Copy link
Member

kvark commented Apr 8, 2020

@aloucks you are posting errors from wgpu-rs, not this repo.
These are addressed by gfx-rs/wgpu-rs#245 and it fails because of a Rust bug still.

@kvark
Copy link
Member

kvark commented Apr 8, 2020

Actually @Luro02 is also concerned about wgpu-rs repo / docs, so we can close this as a dupe.

@kvark kvark closed this as completed Apr 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help required We need community help to make this happen. type: bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants