Ignore non doc attributes at top level genrated by ppx #819
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
Julow
reviewed
Feb 4, 2022
src/loader/doc_attr.ml
Outdated
| @@ -139,7 +139,7 @@ let extract_top_comment internal_tags ~classify parent items = | |||
| let rec extract ~classify = function | |||
| | hd :: tl as items -> ( | |||
| match classify hd with | |||
| | Some (`Attribute attr) -> ( | |||
| | Some (`Attribute ({ Parsetree.attr_name = { txt = "ocaml.text" ; _ }; _ } as attr)) -> ( | |||
There was a problem hiding this comment.
Matching this is already the responsibility of parse_attribute. I think what you mean is to change the None case below to continue iterating rather than stopping.
There was a problem hiding this comment.
Indeed, i missed that. Thanks !
jorisgio
force-pushed
the
extract_top_comment_from_ppx_files
branch
from
eed0688
to
03b4dc5
Compare
Julow
approved these changes
Feb 4, 2022
|
|
I mean that there's documentation about what is "ignored" at the beginning of a file in |
|
We could also do with a CHANGES entry. |
jonludlam
pushed a commit
that referenced
this pull request
Feb 5, 2022
|
Thanks @jorisgio ! |
jonludlam
added a commit
to jonludlam/opam-repository
that referenced
this pull request
Feb 8, 2022
CHANGES: Additions - New subcommand to resolve references (@panglesd, @lubega-simon, ocaml/odoc#812) - Improved rendering of long signatures (@panglesd, ocaml/odoc#782) - Handle comments attached to open statement as floating comment, instead of dropping them (@panglesd, ocaml/odoc#797) - Empty includes (containing entirely shadowed entries) are now hidden (@panglesd, ocaml/odoc#798) Bugs fixed - Fix a missing Result constructor during compile. This will cause some functor arguments to have different filenames (@jonludlam, ocaml/odoc#795) - Better memory/disk space usage when handling module alias chains (@jonludlam, ocaml/odoc#799) - Resolving class-type paths (ie., `val x : #c`) (@jonludlam, ocaml/odoc#809) - Skip top-level attributes while extracting the top comment. Fix top-comment extraction with PPX preprocessing (@jorisgio, ocaml/odoc#819) - Better handling of @canonical tags (@jonludlam, ocaml/odoc#820) - css: improved layout (@jonludlam, @Julow, ocaml/odoc#822)
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, odoc fails to extract synopsis from a signature pre-processed by a ppx. This is because ppx add a "ocaml.ppx.context" attribute at top level before the top comment.
I'm not sure the current fix is the best way to fix, since it uses string matching "ocaml.text" to continue unrolling the list of items until it finds an attribute that is a document.