Skip to content

docs(pnet): use backticks for referencing types#3252

Merged
mergify[bot] merged 1 commit into
masterfrom
fix/rustdoc-error
Dec 16, 2022
Merged

docs(pnet): use backticks for referencing types#3252
mergify[bot] merged 1 commit into
masterfrom
fix/rustdoc-error

Conversation

@thomaseizinger
Copy link
Copy Markdown
Contributor

Description

With the update to Rust 1.66, rustdoc is (rightfully) complaining about us writing bad HTML. <u8> is interpreted as an unclosed HTML tag. See https://github.com/libp2p/rust-libp2p/actions/runs/3708901592/jobs/6286942010#step:6:1380 for example.

Notes

Need urgent approval please as this is blocking other PRs from merging.

Links to any relevant issues

Open Questions

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • A changelog entry has been made in the appropriate crates

@jxs jxs changed the title doc(pnet): use backticks for referencing types docs(pnet): use backticks for referencing types Dec 16, 2022
@jxs jxs added the send-it label Dec 16, 2022
@mergify mergify Bot merged commit e960aab into master Dec 16, 2022
@thomaseizinger
Copy link
Copy Markdown
Contributor Author

@Mergifyio backport rust-v050-testplan

@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Feb 10, 2023

backport rust-v050-testplan

✅ Backports have been created

Details

mergify Bot pushed a commit that referenced this pull request Feb 10, 2023
With the update to Rust 1.66, rustdoc is (rightfully) complaining about us writing bad HTML. `<u8>` is interpreted as an unclosed HTML tag. See https://github.com/libp2p/rust-libp2p/actions/runs/3708901592/jobs/6286942010#step:6:1380 for example.

(cherry picked from commit e960aab)
thomaseizinger added a commit that referenced this pull request Feb 10, 2023
docs(pnet): use backticks for referencing types (#3252)

With the update to Rust 1.66, rustdoc is (rightfully) complaining about us writing bad HTML. `<u8>` is interpreted as an unclosed HTML tag. See https://github.com/libp2p/rust-libp2p/actions/runs/3708901592/jobs/6286942010#step:6:1380 for example.

(cherry picked from commit e960aab)

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
@thomaseizinger
Copy link
Copy Markdown
Contributor Author

@Mergifyio backport rust-v049-testplan rust-v048-testplan

@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Feb 10, 2023

backport rust-v049-testplan rust-v048-testplan

❌ No backport have been created

Details
  • Backport to branch rust-v049-testplan failed: Branch not found
  • Backport to branch rust-v048-testplan failed: Branch not found

@thomaseizinger
Copy link
Copy Markdown
Contributor Author

@Mergifyio backport rust-v049-testplan

@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Feb 10, 2023

backport rust-v049-testplan

❌ No backport have been created

Details
  • Backport to branch rust-v049-testplan failed: Branch not found

@thomaseizinger
Copy link
Copy Markdown
Contributor Author

@Mergifyio backport rust-v048-testplan

@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Feb 10, 2023

backport rust-v048-testplan

❌ No backport have been created

Details
  • Backport to branch rust-v048-testplan failed: Branch not found

@thomaseizinger
Copy link
Copy Markdown
Contributor Author

@Mergifyio backport rust-v0490-testplan rust-v0480-testplan

mergify Bot pushed a commit that referenced this pull request Feb 10, 2023
With the update to Rust 1.66, rustdoc is (rightfully) complaining about us writing bad HTML. `<u8>` is interpreted as an unclosed HTML tag. See https://github.com/libp2p/rust-libp2p/actions/runs/3708901592/jobs/6286942010#step:6:1380 for example.

(cherry picked from commit e960aab)
mergify Bot pushed a commit that referenced this pull request Feb 10, 2023
With the update to Rust 1.66, rustdoc is (rightfully) complaining about us writing bad HTML. `<u8>` is interpreted as an unclosed HTML tag. See https://github.com/libp2p/rust-libp2p/actions/runs/3708901592/jobs/6286942010#step:6:1380 for example.

(cherry picked from commit e960aab)
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Feb 10, 2023

backport rust-v0490-testplan rust-v0480-testplan

✅ Backports have been created

Details

thomaseizinger added a commit that referenced this pull request Feb 10, 2023
docs(pnet): use backticks for referencing types (#3252)

With the update to Rust 1.66, rustdoc is (rightfully) complaining about us writing bad HTML. `<u8>` is interpreted as an unclosed HTML tag. See https://github.com/libp2p/rust-libp2p/actions/runs/3708901592/jobs/6286942010#step:6:1380 for example.

(cherry picked from commit e960aab)

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
thomaseizinger added a commit that referenced this pull request Feb 10, 2023
docs(pnet): use backticks for referencing types (#3252)

With the update to Rust 1.66, rustdoc is (rightfully) complaining about us writing bad HTML. `<u8>` is interpreted as an unclosed HTML tag. See https://github.com/libp2p/rust-libp2p/actions/runs/3708901592/jobs/6286942010#step:6:1380 for example.

(cherry picked from commit e960aab)

Co-authored-by: Thomas Eizinger <thomas@eizinger.io>
@thomaseizinger thomaseizinger deleted the fix/rustdoc-error branch February 24, 2023 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants