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

docs: correct formatting issues #983

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kj800x
Copy link

@kj800x kj800x commented Dec 30, 2024

I'm not entirely sure of the correct syntax or the process for testing these docs locally (just doing a drive-by commit on GitHub). I noticed that some of the Warning blocks in the docs had broken formatting. This PR should fix that.

Before

image

image

image

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.99%. Comparing base (d07cf71) to head (52701c4).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #983   +/-   ##
=======================================
  Coverage   71.99%   71.99%           
=======================================
  Files          24       24           
  Lines        3642     3642           
=======================================
  Hits         2622     2622           
  Misses        880      880           
  Partials      140      140           

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

@chengfang
Copy link
Collaborator

@kj800x thanks for the fix. Can you fix the DCO error by signing off the commit? After that, it should be good to go.

@kj800x
Copy link
Author

kj800x commented Jan 1, 2025

Thanks for taking a look! I noticed the DCO check failed and looked into it, but I'm not familiar with what 'signing off' a commit entails or its significance. Since this isn't mentioned in the README or contributing documentation, would you mind clarifying? I'm hesitant to sign my name to something without knowing what that means. It might also be helpful to add guidance on this to the contributing docs for future contributors.

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