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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(cordyceps): misc. documentation fixes #317

Merged
merged 4 commits into from
Sep 14, 2022
Merged

doc(cordyceps): misc. documentation fixes #317

merged 4 commits into from
Sep 14, 2022

Conversation

hawkw
Copy link
Owner

@hawkw hawkw commented Sep 14, 2022

No description provided.

This fixes a case of incorrect rendering for Markdown footnotes in the
`Linked` trait's documentation. Apparently two separate footnotes need
to be separated by a line of whitespace in order to render correctly.
Oops.
This just adds a doc link in the docs for
`mpsc_queue::TryDequeueError`'s `Inconsistent` variant to link to the
section in the `MpscQueue` docs on inconsistent states.
We don't need these any longer, since the examples now use
`ptr::addr_of_mut!` rather than layout-dependent casting.
@hawkw hawkw enabled auto-merge (rebase) September 14, 2022 16:11
@hawkw hawkw merged commit d37ec8c into main Sep 14, 2022
@hawkw hawkw deleted the eliza/fix-footnotes branch September 14, 2022 16:19
hawkw added a commit that referenced this pull request Sep 14, 2022
This fixes a case of incorrect rendering for Markdown footnotes in the
`Linked` trait's documentation. Apparently two separate footnotes need
to be separated by a line of whitespace in order to render correctly.
Oops.
hawkw added a commit that referenced this pull request Sep 14, 2022
This just adds a doc link in the docs for
`mpsc_queue::TryDequeueError`'s `Inconsistent` variant to link to the
section in the `MpscQueue` docs on inconsistent states.
hawkw added a commit that referenced this pull request Sep 14, 2022
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.

None yet

1 participant