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

Update admonition in readme to fix a glitch/bug in GitHub web UI #174

Merged
merged 9 commits into from
Mar 28, 2024

Conversation

nfelt14
Copy link
Collaborator

@nfelt14 nfelt14 commented Mar 28, 2024

Proposed changes

A simple update to the table to make sure that GitHub renders the admonition correctly.

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

  • Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have followed the guidelines in the CONTRIBUTING document
  • I have signed the CLA
  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have performed a self-review of my code
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • Basic linting passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added necessary documentation (if appropriate)
  • I have updated the Changelog with a brief description of my changes

@nfelt14 nfelt14 requested a review from a team as a code owner March 28, 2024 15:25
@tek-githubbot-1010 tek-githubbot-1010 requested a review from a team March 28, 2024 15:25
@nfelt14 nfelt14 enabled auto-merge (squash) March 28, 2024 15:26
Copy link

codecov bot commented Mar 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (434a485) to head (41cc96b).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #174   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          170       170           
  Lines         3804      3804           
  Branches       643       643           
=========================================
  Hits          3804      3804           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nfelt14 nfelt14 merged commit 9ed0dc0 into tektronix:main Mar 28, 2024
38 checks passed
nfelt14 added a commit to nfelt14/tm_devices that referenced this pull request May 2, 2024
…tronix#174)

* docs: Update readme admonition to make it display better in GitHub.

Signed-off-by: Nicholas Felt <[email protected]>
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.

3 participants