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

Fix a few cosmetic issues in the primary README #68

Merged
merged 2 commits into from
Dec 11, 2023
Merged

Conversation

abeltrano
Copy link
Contributor

Type

  • Bug fix
  • Feature addition
  • Feature update
  • Documentation
  • Build Infrastructure

Side Effects

  • Breaking change
  • Non-functional change

Goals

  • Ensure the README doesn't have formatting errors.

Technical Details

  • Remove an extraneous backtick.
  • Move a [!WARNING] block to be un-indented due to a recent change described here that introduced a regression for tabbed support.

Test Results

  • Visually inspected new rendered README and confirmed no formatting issues are present.

Reviewer Focus

  • Consider whether there are any formatting, spelling, or grammar errors that need fixing.

Future Work

  • None

Checklist

  • Build target all compiles cleanly.
  • clang-format and clang-tidy deltas produced no new output.
  • Newly added functions include doxygen-style comment block.

@abeltrano abeltrano requested a review from a team as a code owner December 11, 2023 20:23
@abeltrano abeltrano merged commit 20f01a9 into develop Dec 11, 2023
1 of 4 checks passed
@abeltrano abeltrano deleted the readmefixes branch December 11, 2023 20:26
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