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

chore: escape brackets in documentation #70

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

verpeteren
Copy link

Cargo doc was raising a warning like this:

warning: unresolved link to `i`
    --> src/lib.rs:1053:50
     |
1053 |     /// Note, SSE2 and SSE4 will store when mask[i] is nonzero, where AVX2
     |                                                  ^ no item named `i` in scope
     |
     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
     = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default

Cargo doc was raising a warning like this:

```
warning: unresolved link to `i`
    --> src/lib.rs:1053:50
     |
1053 |     /// Note, SSE2 and SSE4 will store when mask[i] is nonzero, where AVX2
     |                                                  ^ no item named `i` in scope
     |
     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
     = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
```
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 this pull request may close these issues.

1 participant