Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove unnecessary inheritDocs from plugin #1491

Open
Swiddis opened this issue Apr 4, 2023 · 0 comments
Open

Remove unnecessary inheritDocs from plugin #1491

Swiddis opened this issue Apr 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Priority-Low

Comments

@Swiddis
Copy link
Collaborator

Swiddis commented Apr 4, 2023

Is your feature request related to a problem?
The Kotlin KDoc Spec does not recognize the {@inheritDoc} annotation. Instead it automatically inherits documentation from one layer up. There are currently many methods throughout the Observability plugin that use this annotation and it produces broken documentation, simply removing it fixes the behavior.

What solution would you like?
Remove unused {@inheritDoc} from the codebase.

What alternatives have you considered?
N/A

Do you have any additional context?
Before:
documentation with inherit doc

After:
documentation without inherit doc

@Swiddis Swiddis added documentation Improvements or additions to documentation good first issue Good for newcomers Priority-Low labels Apr 4, 2023
@Swiddis Swiddis removed the untriaged label Apr 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Priority-Low
Projects
None yet
Development

No branches or pull requests

1 participant