Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Fix documentation warnings in ConstantPool #952

Merged
merged 1 commit into from
Aug 29, 2019

Conversation

abrown
Copy link
Collaborator

@abrown abrown commented Aug 28, 2019

Prior to this commit I would see warnings like the following when running cargo +nightly doc:

warning: `[ir::ConstantData]` cannot be resolved, ignoring it...
  --> cranelift-codegen/src/ir/constant.rs:49:22
   |
49 | /// [`ConstantData`](ir::ConstantData)).
   |                      ^^^^^^^^^^^^^^^^ cannot be resolved, ignoring
   |
   = note: `#[warn(intra_doc_link_resolution_failure)]` on by default
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

I believe the trick is to prepend crate (and not cranelift_codegen or a relative path) for references inside the file's own crate.

Copy link
Member

@bnjbvr bnjbvr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@bnjbvr bnjbvr merged commit 2f146c6 into bytecodealliance:master Aug 29, 2019
@abrown abrown deleted the fix-doc-warnings branch August 29, 2019 15:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants