Skip to content

Remove misleading table definitions

Thomas Randolph requested to merge tor/docs/markdown-table-clarification into master

What does this MR do?

Problem

In the documentation for our markdown tables, the table definitions have misleading tables that - for example - increase the amount of hyphens for each subsequent column. In the cells, the text content also gets longer in each subsequent cell. Some users may infer that the cells are wider because of the increasing amount of hyphens, rather than that it's being computed dynamically from the content of the table body.

Fix

This MR updates the docs with three changes:

  1. Each table example has exactly 3 hyphens
  2. Duplicated table example columns with more than 3 hyphens are deleted entirely
  3. The descriptive text of the table definition is updated to clearly state that 1 hyphen is all that's necessary, and controlling the width of the columns isn't possible.

Screenshots (strongly suggested)

Before After
image image
image image

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Thomas Randolph

Merge request reports

Loading