New odoc rules (minimal) #410
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
rgrinberg
commented
Jan 13, 2018
| val create : name:string -> t | ||
|
|
||
| val odoc_file : doc_dir:Path.t -> t -> Path.t | ||
| val odoc_input : doc_dir:Path.t -> t -> Path.t |
There was a problem hiding this comment.
I can remove this refactoring if necessary. It proved to be useful for experimenting with renaming things, but now it's purpose seems dubious. It still doesn't seem so bad to keep this stuff behind an interface so I'm leaning to keep it.
rgrinberg
force-pushed
the
new-odoc-minimal
branch
from
5ad8a29 to
35d716b
Compare
|
OK, I've rebased this on top of the lazy rules stuff. Will merge and prepare a release next week unless anyone objects. |
These now work for libs defined in the same dir
rgrinberg
force-pushed
the
new-odoc-minimal
branch
from
35d716b to
d2af910
Compare
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.
This is a minimal version of #304. It only contains fixes to the rules to follow odoc's latest conventions. It doesn't include any of the installation stuff and the documentation stanza.
I'd prefer not to rush with adding a new stanza, especially since there's some wrinkles to the proposed design. Let's just review and merge this PR so that we unblock releasing jbuilder. We'll have plenty of time to design the documentation stanza after the release.
I'll make a separate PR for that work once this one is merged.