doc: add index.mld for dune-glob #7989
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
|
You should probably mention that this library is not stable. It has a "versioned" api but that's only because it's needed for the DAP. Since the DAP is not stable either, this package doesn't need a stable API. |
|
Ah OK. Should it be mentioned in the opam file like we do for stdune or is it reasonable to depend on this package? |
|
It hasn't changed in a long time so I suppose it's safe enough. But I would still mention somewhere that we don't actually have any stability guarantees like the module name might imply. |
As for other packages: an introduction, an example, a proper link. The doc for `of_string` could point to a `syntax.mld` (this lives in `dependency-spec.rst` at the moment), but that would be better with table support. See ocaml#7988. Signed-off-by: Etienne Millon <me@emillon.org>
Signed-off-by: Etienne Millon <me@emillon.org>
emillon
force-pushed
the
doc-odoc-dune-glob
branch
from
6740a6d
to
4ddf34d
Compare
|
I added a section about that. |
rgrinberg
approved these changes
Jun 20, 2023
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.
As for other packages: an introduction, an example, a proper link.
The doc for
of_stringcould point to asyntax.mld(this lives independency-spec.rstat the moment), but that would be better with table support. See #7988.