Bug 244543 - Vertical alignment off in table in "8. Commit Log Messages" in Committers Guide
Summary: Vertical alignment off in table in "8. Commit Log Messages" in Committers Guide
Status: Closed Overcome By Events
Alias: None
Product: Documentation
Classification: Unclassified
Component: Website (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-doc (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-03-01 13:54 UTC by Gerald Pfeifer
Modified: 2021-02-08 22:41 UTC (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Gerald Pfeifer freebsd_committer freebsd_triage 2020-03-01 13:54:57 UTC 
Looking at
https://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/commit-log-message.html
the table is a bit confusing in the elements in the left column are vertically
centered.

For longer entries in the right column this makes it not immediate (and
definitely requiring some mental focus) to identify which lines on the
right side belong to which elements on the left side.

In particular this holds for the "Approved by:" entry, others are easier,
though at least look a bit odd.
Comment 1 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2021-02-08 22:41:41 UTC 
We improved the tables with the migration of Hugo/AsciiDoctor. I hope this help with the readability of the tables.