Use tables when it is appropriate to represent sets of related data.
Do not use tables for component parameters. Instead, use component parameters.
- Use three hyphens per column. This is to make editing multiple files easier via pattern matching.
- Use a pipe
|before and after each set of
- Do not include spaces before or after pipe characters. Again, this is to make editing multiple files easier via pattern matching.
- Like lists having at least two points or steps, a table should have at least two rows.
For example, a three-column table would be formatted like so:
|Property|Setting|Description| |---|---|---| |Name|String|A human-readable name for the environment.| |Age|Integer|The age of the environment.| |And|so|on| |And|so|forth|