Skip to content

Added definition list formatting rule #4144

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.

Sign up for GitHub

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

Merged
knative-prow-robot merged 2 commits into from
Aug 20, 2021
+8 −0
Merged

Added definition list formatting rule #4144

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75b93db
Added definition list formatting rule
RichardJJG Aug 20, 2021
09f1750
Add example
RichardJJG Aug 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/help/contributor/style-guide/style-and-formatting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ between the number and the unit.
|Click **Fork** | Click "Fork"
|Select **Other** | Select "Other"

### Use tables for definition lists

When listing terms and their definitions, use table formatting instead of definition list formatting.
Copy link
Copy Markdown
Contributor

@antoineco antoineco Aug 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see that all guidelines surrounding this one are providing a good/bad example instead of a sentence. Should we remain consistent and use an example instead/additionally here too?

Copy link
Copy Markdown
Contributor Author

@RichardJJG RichardJJG Aug 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair -- it was a little awkward to add the example, but not as bad as I thought.


|:white_check_mark: Correct |:no_entry: Incorrect
|--------------------|-----
|`|Value |Description |`<br>`|------|---------------------|`<br>`|Value1|Description of Value1|`<br>`|Value2|Description of Value2|`|`Value1`<br>`: Description of Value1`<br><br>`Value2`<br>`: Description of Value2`|

## General style

### Use upper camel case for Knative API objects
Expand Down