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

In a class doc. page in methods list reader doesn't know if a method's description is complete or there are more paragraphs that were cut out #3442

Open
atyrin opened this issue Jan 9, 2024 · 0 comments
Labels
enhancement An issue for a feature or an overall improvement

Comments

@atyrin
Copy link
Contributor

atyrin commented Jan 9, 2024

In a class doc. page in methods list Dokka shortens their description by leaving only 1st paragraph. IMO, that's fine.
The problem is that reader doesn't know - is the description complete, or there are more paragraphs. I suggest to add something like "..." or "Read more ..." if there are, for reducing uncertainty.

image
image1

Migrated from https://youtrack.jetbrains.com/issue/KT-50285

@atyrin atyrin added the enhancement An issue for a feature or an overall improvement label Jan 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement
Projects
None yet
Development

No branches or pull requests

1 participant