feat: add @[inheritDoc]
attribute
#1480
Merged
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 attribute allows you to specify another declaration to copy the docstring for the given declaration from. Example:
This will give
bar
the same docstring asfoo
. It does not otherwise link the two declarations, but users that arrive atbar
can click on thefoo
identifier to jump to the other declaration.For
infix
andnotation
declarations, it is also possible to omit the identifier, in which case it will use the declaration the notation unfolds to. For example:This gives the
>+<
syntax the same docstring asNat.add
.@[inheritDoc]
is also integrated into themissingDocs
linter, which will not lint on declarations which have@[inheritDoc]
but no documentation.