Driver and convention: includes libs from packages in odoc-config.sexp
#1343
Conversation
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
This allows to reference libraries from packages that were added to `odoc-config.sexp`'s `(packages ...)` field, without having to explicit add the library to the `(libraries ...)` field. This makes it less cumbersome to use.
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.
Currently, the
packagesandlibrariesfields ofodoc-config.sexpare used to determine what can be referenced. More precisely:in
odoc-config.sexpmeans that we can reference the pages frompkg1and the modules fromlib1.This forces the doc author to specify both if they want to references pages and modules. For instance, to be able to both reference the
brrffi manual and theBrrmodule, one would need the followingodoc-config.sexp:This feels redundant. Moreover, the driver anyway needs to group libraries in packages. With this PR, I propose to update the convention so that the
(packages ...)field allows to link both pages and the modules of a library belonging to the package. In the example, the following would suffice:I updated both the docs, and the odoc reference driver.