Skip to content

Tables in documentation abruptly truncate sentences #880

@garrettgman

Description

@garrettgman

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions