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

Use inline code blocks for partial names in documentation #791

Closed
wants to merge 1 commit into from

Conversation

gravitystorm
Copy link

This also brings the documentation into line with the existing markdown used in install_package.md

Description

This avoids CI from failing due to markdownlint warnings.

Issues Resolved

None

Check List

  • A summary of changes made is included in the CHANGELOG under ## Unreleased
  • New functionality includes testing.
  • New functionality has been documented in the README if applicable.

None of the above apply

This also brings the documentation into line with the existing
markdown used in install_package.md

This avoids CI from failing due to markdownlint warnings.

Signed-off-by: Andy Allan <[email protected]>
@gravitystorm gravitystorm requested a review from a team as a code owner October 27, 2023 10:14
@damacus damacus self-assigned this Oct 31, 2023
@damacus
Copy link
Member

damacus commented Oct 31, 2023

Excellent, thank you.

Can you add a changelog entry and I can ship this change today 👍🏼

@damacus damacus added the Waiting on Contributor Awaiting on the person who raised this to update label Oct 31, 2023
@damacus
Copy link
Member

damacus commented Oct 31, 2023

I think I've now fixed this via #792. If this isn't the case and it's wrong please let me know.

@damacus damacus closed this Oct 31, 2023
@gravitystorm
Copy link
Author

Looks good to me, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Waiting on Contributor Awaiting on the person who raised this to update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants