Skip to content

Added definition list formatting rule#4144

Merged
knative-prow-robot merged 2 commits into
knative:mkdocsfrom
RichardJJG:4072
Aug 20, 2021
Merged

Added definition list formatting rule#4144
knative-prow-robot merged 2 commits into
knative:mkdocsfrom
RichardJJG:4072

Conversation

@RichardJJG
Copy link
Copy Markdown
Contributor

@RichardJJG RichardJJG commented Aug 20, 2021

Fixes #4072

@google-cla google-cla Bot added the cla: yes Indicates the PR's author has signed the CLA. label Aug 20, 2021
@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 20, 2021 •
edited
Loading

✔️ Deploy Preview for knative ready!

🔨 Explore the source changes: 09f1750

🔍 Inspect the deploy log: https://app.netlify.com/sites/knative/deploys/611fa7fdff511b0008aacfc8

😎 Browse the preview: https://deploy-preview-4144--knative.netlify.app/development/help/contributor/style-guide/style-and-formatting

@knative-prow-robot knative-prow-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 20, 2021
antoineco
antoineco reviewed Aug 20, 2021
View reviewed changes
Comment thread docs/help/contributor/style-guide/style-and-formatting.md

### 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.

@abrennan89
Copy link
Copy Markdown
Contributor

abrennan89 commented Aug 20, 2021

/lgtm
/approve

Thanks @RichardJJG 🙂

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 20, 2021
@knative-prow-robot
Copy link
Copy Markdown
Contributor

knative-prow-robot commented Aug 20, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abrennan89, RichardJJG

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [RichardJJG,abrennan89]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@abrennan89 abrennan89 added this to the v0.26.0 milestone Aug 20, 2021
@knative-prow-robot knative-prow-robot merged commit 65b1671 into knative:mkdocs Aug 20, 2021
@RichardJJG RichardJJG deleted the 4072 branch August 20, 2021 13:31
@snyk-bot snyk-bot mentioned this pull request Feb 21, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@antoineco antoineco antoineco left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@abrennan89 abrennan89

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Milestone

v0.26.0

Development

Successfully merging this pull request may close these issues.

Style Guide: Enshrine or discard definition list formatting

4 participants

@RichardJJG @abrennan89 @knative-prow-robot @antoineco