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: fix invalid rst syntax #284

Merged
merged 1 commit into from
Oct 20, 2023
Merged

fix: fix invalid rst syntax #284

merged 1 commit into from
Oct 20, 2023

Conversation

infinitewarp
Copy link
Member

@infinitewarp infinitewarp commented Oct 20, 2023

I found these broken lines when looking at the actual man page. Broken output is quite ugly with unformatted junk like this throughout:

       Configuring the server ~~~~~~~~~~~~~~~~~~~~~~

...

       Listing and Showing Credentials ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Remember that RST is pretty strict about its syntax. The "underlines" for section headers should be the exact same length as the text above them. It's not as forgiving as many markdown flavors are.

@codecov-commenter
Copy link

Codecov Report

Merging #284 (d55e3f5) into main (27f4f7e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #284   +/-   ##
=======================================
  Coverage   93.73%   93.73%           
=======================================
  Files          67       67           
  Lines        2827     2827           
=======================================
  Hits         2650     2650           
  Misses        177      177           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@infinitewarp infinitewarp merged commit 4e4dc7a into main Oct 20, 2023
6 checks passed
@infinitewarp infinitewarp deleted the fix-broken-man-page branch October 20, 2023 18:37
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