Line edit ocamldoc differences #1178
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
panglesd
approved these changes
Jul 30, 2024
There was a problem hiding this comment.
Minor comments inline!
You based your PR on top of #1175, which I only understood after my review.
One thing to know is that we are likely going to deleted the driver.mld file quite soon, so no need to spend too much time on it! When we rewrite it, we'll not forget to ask you for a review! 🙂
| @@ -120,7 +120,7 @@ Please note: it's only necessary to link the non-hidden modules (i.e., without a | |||
| {ol {- Generation: odoc html-generate | |||
| }} | |||
|
|
|||
| Once the compile and link phases are complete, the resulting [odocl] files may be rendered in a variety of formats. In this example we output HTML. | |||
| Once the compile and link phases are complete, the resulting [odocl] files may be rendered in a variety of formats. In this example we output HTML: | |||
There was a problem hiding this comment.
I find the : confusing. What about
Suggested change
| Once the compile and link phases are complete, the resulting [odocl] files may be rendered in a variety of formats. In this example we output HTML: | |
| Once the compile and link phases are complete, the resulting [odocl] files may be rendered in a variety of formats. In the driver exemplified in this document, we output HTML. |
There was a problem hiding this comment.
I guess my comment never sent yesterday!
That was my mistake with the: -- I guess I saw a phantom example after it! 🙂
What about: "For the driver exemplified herein, we output HTML."
Co-authored-by: panglesd <[email protected]>
Co-authored-by: panglesd <[email protected]>
Oh no! My mistake! 😦 |
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.
Minor line editing, mostly.