Improve doc generation and update ocamlformat - #916
Open
dannywillems wants to merge 3 commits into
Open
Conversation
Replace deprecated and unresolvable odoc cross-references with plain
code formatting to eliminate all documentation build warnings.
Changes:
- request.mli: replace {!recfield:...} and {!const:...} with plain code
- snark0.mli: replace unresolvable cross-references with plain code
- snark_intf.ml: replace {!val:Field.*}, {!type:Field.*}, {!module:...}
and other unresolvable references with plain code formatting
Update ocamlformat version in both the configuration file and CI workflow.
Apply new formatting rules from ocamlformat 0.28.1, primarily affecting functor argument formatting and spacing around parentheses.
dannywillems
commented
Jan 21, 2026
| - name: Format | ||
| run: | | ||
| eval $(opam env) | ||
| opam install ocamlformat.0.20.1 # match mina's version |
Contributor
Author
There was a problem hiding this comment.
Updated to have odoc>=3.0.0
dannywillems
changed the title
martyall
approved these changes
Jan 21, 2026
dannywillems
enabled auto-merge
January 22, 2026 12:52
dannywillems
disabled auto-merge
January 22, 2026 12:52
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.
No description provided.