Add a linebreak between contract and the documentation in the doc output #1520
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
The markdown output of `nickel doc` for record fields with both a contract and a documentation currently looks like ```markdown - `foo | Dyn` documentation ``` which in strict markdown is equivalent to ```markdown - `foo | Dyn` documentation ``` and isn't really nice once converted to Html. Change that to ```markdown - `foo | Dyn` \ documentation ``` which renders `documentation` on a newline (still whithin the same bullet point though)
vkleen
approved these changes
Aug 9, 2023
|
Grmph, I didn't check the tests (bad). I'm going on vacation this evening and probably won't have time to fix it in the meantime, feel free to pick it up if you want anyone |
yannham
approved these changes
Aug 9, 2023
There was a problem hiding this comment.
I was going to say something about affecting the user manual, but the latter is built from the JSON export I believe, right, @vkleen ? @thufschmitt might or might not be useful for you, but AFAIR it was just easier to generate HTML from a json export of the documentation, which you can do with nickeld doc --format json.
|
That's correct, the user manual is formatted on the website from the JSON output. |
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.
The markdown output of
nickel docfor record fields with both a contract and a documentation currently looks likewhich in strict markdown is equivalent to
and isn't really nice once converted to Html.
Change that to
which renders
documentationon a newline (still whithin the same bullet point though).Screenshots on a basic
pandocrendering: