search

google / WebFundamentals

Former git repo for WebFundamentals on developers.google.com
Apache License 2.0
13.85k stars 2.57k forks source link

We shouldn't have one-item lists in admonitions #286

Closed PaulKinlan closed 10 years ago

PaulKinlan commented 10 years ago

Issue by Meggin Tuesday Apr 29, 2014 at 20:34 GMT # Sample: Friday Sep 13, 2013 at 22:58 GMT Originally opened as https://github.com/PaulKinlan/WebDocs/issues/138

Admonitions (like a note or TL;DR, etc.) that cover just one concept shouldn't contain that concept in a list. One-item lists are bad. Just make it a sentence.

For example, Note under 'Add content to the page' should just say 'Styling will come later', without being in a list.

PaulKinlan commented 10 years ago

Comment by PaulKinlan Tuesday Apr 29, 2014 at 21:02 GMT # Sample: Friday Sep 13, 2013 at 22:58 GMT

Ok, we need this to be in v2, the tooling requires a list.

maxh commented 10 years ago

In this specific case, can we add another takeaway to patch over the issue?

On Fri, May 9, 2014 at 6:52 AM, Paul Kinlan notifications@github.comwrote:

https://github.com/PaulKinlan Comment by PaulKinlan https://github.com/PaulKinlan *Tuesday Apr 29, 2014 at 21:02 GMT # Sample: Friday Sep 13, 2013 at 22:58

GMT*

Ok, we need this to be in v2, the tooling requires a list.

— Reply to this email directly or view it on GitHubhttps://github.com/google/WebFundamentals/issues/286#issuecomment-42667869 .

PaulKinlan commented 10 years ago

I have changed it to be in line comment.