Lift deprecated and alerts attributes into odoc tags
#828
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
panglesd
changed the title
deprecated and alerts attributes into odoc tags
The attribute is recognized by the loader and appended to the corresponding comment. It is rendered similarly to tags. If both the [@@deprecated] compiler attribute and the @deprecated odoc tag are specified, the compiler attribute is ignored. [@@@deprecated] at the beginning of the file, before or after the first comment, is also handled. Co-authored-by: Paul-Elliot <[email protected]>
Remove some code duplication and write the pattern-match on attribute names only once.
Signed-off-by: Paul-Elliot <[email protected]>
panglesd
force-pushed
the
deprecated-attr
branch
from
b2f3d5b to
95393ab
Compare
mseri
pushed a commit
to ocaml/opam-repository
that referenced
this pull request
Dec 13, 2022
CHANGES: Additions - New unstable option `--as-json` for the HTML renderer that emits HTML fragments (preamble, content) together with metadata (table of contents, breadcrumbs, whether katex is used) in JSON format. (@sabine, ocaml/odoc#908) - New maths support via `{m ... }` and `{math ... }` tags. (@giltho, @gpetiot, ocaml/odoc#886) - Various optimisations (@jonludlam, ocaml/odoc#870, ocaml/odoc#883) - Better handling of alerts and deprecation notices. (@panglesd, ocaml/odoc#828) - Handle language tags on code blocks (@Julow, ocaml/odoc#848) Bugfixes - Shadowing issues (@jonludlam, ocaml/odoc#853) - Layout fixes and improvements (@panglesd, ocaml/odoc#832, ocaml/odoc#839, ocaml/odoc#847) - Handle comments on class constraints and inherit (@Julow, ocaml/odoc#844) - Disable the missing root warning (@jonludlam, ocaml/odoc#881)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR lifts
deprecatedand alerts intoodoctags.[@@deprecated]and[@@alert deprecated]are handled internally the same way. and rendered similarly to the existing@deprecatedodoc tag. Alerts are rendered asalert alert_namefollowed by the possible payload.When an item contains both a
deprecatedattribute and an attached comment with adeprecatedodoctag, only theodoctag is kept. This allows to use references in@deprecatedmessage, as payloads from alerts or attribute are not parsed by odoc.This PR closes #406