Fix some formatting inconsistencies #5018
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AaronDewes
changed the title
|
Actually, the \ seem unnecessary, can we just get rid of all of them? |
doc/lightning-connect.7.md
Outdated
| @@ -4,7 +4,7 @@ lightning-connect -- Command for connecting to another lightning node | |||
| SYNOPSIS | |||
| -------- | |||
|
|
|||
| **connect** *id* \[*host* *port*\] | |||
| **connect** *id* \[*host*\] \[*port*\] | |||
There was a problem hiding this comment.
Actually, this should be '[host [port]]'
|
nack c9f3fba |
I think they make sense to prevent some markdown parsers from thinking this is a link, but I'll remove them, they can be readded if it causes any issues. |
Hmm, did you mistype, or did you have some feedback to share? |
|
Minor regeneration fix... |
|
Needs to be squashed, otherwise good to go 👍 |
cdecker
force-pushed
the
fix-docs-formatting
branch
from
0709fe2 to
91bd19a
Compare
|
Rebased and squashed on top of current |
I've tried automatically parsing the docs, and these inconsistencies made it harder to do that. (I tried to do that for a project which I can't share yet, I'm not sure if it'll even work).
rustyrussell
force-pushed
the
fix-docs-formatting
branch
from
91bd19a to
f4d93e4
Compare
|
Rebased again (should fix flakes!) |
|
Ack f4d93e4 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've tried automatically parsing the docs (for a WIP TypeScript client libarary which is automatically generated from docs + schemas), and these inconsistencies made it harder to do that.