Fix documentation strings#30
Merged
Merged
Conversation
The documentation comments in OCaml are opened with "(**" and closed with "*)". All characters in between the open and close markers are interpret as documentation. This lead to '*' being part of the docstring, see: https://mirage.github.io/mirage-xen/mirage-xen/OS/Memory/index.html#type-stat
Contributor
|
Thanks. What's the go-to quick way of previewing the documentation locally when making changes? |
Member
Author
|
@mato |
hannesm
added a commit
to hannesm/opam-repository
that referenced
this pull request
Nov 18, 2021
CHANGES: * Fix OCaml documentation strings (mirage/mirage-xen#30 @hannesm) * Add caml_get_wall_clock to retrieve the wall clock as int64 (mirage/mirage-xen#31 @hannesm) * Don't require opam for the bindings compilation (mirage/mirage-xen#32 @sternenseemann) * Remove checksum_stubs and alloc_pages_stubs (available in mirage-tcpip and io-page), to keep in sync with mirage-solo5 (mirage/mirage-xen#33 @dinosaure, adapted by @hannesm to mirage-xen)
arbipher
pushed a commit
to arbipher/opam-repository
that referenced
this pull request
Nov 21, 2021
CHANGES: * Fix OCaml documentation strings (mirage/mirage-xen#30 @hannesm) * Add caml_get_wall_clock to retrieve the wall clock as int64 (mirage/mirage-xen#31 @hannesm) * Don't require opam for the bindings compilation (mirage/mirage-xen#32 @sternenseemann) * Remove checksum_stubs and alloc_pages_stubs (available in mirage-tcpip and io-page), to keep in sync with mirage-solo5 (mirage/mirage-xen#33 @dinosaure, adapted by @hannesm to mirage-xen)
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 documentation comments in OCaml are opened with "(**" and closed with ")".
All characters in between the open and close markers are interpret as
documentation. This lead to '' being part of the docstring, see:
https://mirage.github.io/mirage-xen/mirage-xen/OS/Memory/index.html#type-stat