Minimize markup in variand and field descriptions. #7
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.
ocsigen.org
's styles and parser currently assume that variand and field descriptions are simple preformatted comment strings. Meanwhile,wikidoc
, likeocamldoc
, expects the descriptions to be table cells with full documentation styling and block content.This commit changes
wikidoc
to output the descriptions as text close to what is written in the source code, inserting much less markup.I inspected the new output, and it looks correct up to my understanding of Wiki Creole and Ocsigen's extensions. I haven't tested final display on
ocisgen.org
.I think the "right way" to fix this is to change the style and layout on
ocsigen.org
to allow block content in variand info, likeocamldoc
does. However, that seems like an involved project that I'm not ready to do right now. Perhaps that can be done at a later date.In the meantime, this helps to fix ocsigen/ocsigen.org-deprecated#19. To complete the fix, I will also remove
ocamldoc
markup from variands inlwt_unix.mli
.