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

Tables in documentation abruptly truncate sentences #880

Closed
garrettgman opened this issue Dec 8, 2023 · 0 comments · Fixed by #919
Closed

Tables in documentation abruptly truncate sentences #880

garrettgman opened this issue Dec 8, 2023 · 0 comments · Fixed by #919
Milestone

Comments

@garrettgman
Copy link
Contributor

Many pages in the Shiny for Python function reference contain tables that summarize attributes, methods, etc. These tables look like they have errors and typos because of the way they are implemented. For example, this table appears in the documentation of App.

Screenshot 2023-12-08 at 10 34 25 AM

The tables show the beginning of the documentation for each item in the table. If a user clicks through they can find the complete documentation. However, the table truncates the documentation without indicating it is doing so. To the viewer, it looks like the sentences in the table end abruptly, as if the author was careless or had made a typo. The truncation also looks inconsistent: it doesn't happen uniformly at the end of a line. I suggest appending a ... to the end of truncated sentences.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants