Markdownlint fixes #37255
Markdownlint fixes #37255
Conversation
| @@ -205,9 +205,7 @@ Used for creating the CSS animations for our spinners. Included in `scss/_spinne | |||
|
|
|||
|
|
|||
| [color]: {{< docsref "/utilities/colors" >}} | |||
| [display]: {{< docsref "/utilities/display" >}} | |||
There was a problem hiding this comment.
Not sure if this and the next change should ring a bell and mean we are missing a link/or we need to tweak the wording in this page.
| @@ -11,7 +11,7 @@ toc: true | |||
| Offcanvas is a sidebar component that can be toggled via JavaScript to appear from the left, right, top, or bottom edge of the viewport. Buttons or anchors are used as triggers that are attached to specific elements you toggle, and `data` attributes are used to invoke our JavaScript. | |||
|
|
|||
| - Offcanvas shares some of the same JavaScript code as modals. Conceptually, they are quite similar, but they are separate plugins. | |||
| - Similarly, some [source Sass](#sass) variables for offcanvas's styles and dimensions are inherited from the modal's variables. | |||
| - Similarly, some [source Sass](#sass-variables) variables for offcanvas's styles and dimensions are inherited from the modal's variables. | |||
There was a problem hiding this comment.
This was indeed broken
| @@ -126,7 +126,7 @@ The size of `.placeholder`s are based on the typographic style of the parent ele | |||
|
|
|||
| ### Animation | |||
|
|
|||
| Animate placeholders with `.placeholder-glow` or `.placeholder-wave` to better convey the perception of something being _actively_ loaded. | |||
| Animate placeholders with `.placeholder-glow` or `.placeholder-wave` to better convey the perception of something being *actively* loaded. | |||
There was a problem hiding this comment.
Just a question here. Based on the rest of the diff, I suppose that a rule regarding emphasis is set (like MD049). But the other modifications are *word* → _word_. Do you know why it is in the other way just here?
There was a problem hiding this comment.
Yeah, because the default is consistent, see the description.
I don't mind enforcing it, but this way we have the minimum changes.
There was a problem hiding this comment.
I don't have any issues with the consistency but my point is that in the modifications of this PR you have:
- 7 times
*word*->_word_ - 1 time (here)
_word_->*word*(the opposite)
The latter seems weird to me since it breaks the consistency; everything should be _word_ at the end shouldn't it?
There was a problem hiding this comment.
Like I said the default option is consistent per file. I honestly do not
care about it as long as it catches some real issues (like it does).
Oh "per file". OK I didn't have this information so I now understand the behavior. Thx.
|
Like I said the default option is consistent per file. I honestly do not
care about it as long as it catches some real issues (like it does).
…On Tue, Oct 4, 2022, 13:00 Julien Déramond ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In site/content/docs/5.2/components/placeholders.md
<#37255 (comment)>:
> @@ -126,7 +126,7 @@ The size of `.placeholder`s are based on the typographic style of the parent ele
### Animation
-Animate placeholders with `.placeholder-glow` or `.placeholder-wave` to better convey the perception of something being _actively_ loaded.
+Animate placeholders with `.placeholder-glow` or `.placeholder-wave` to better convey the perception of something being *actively* loaded.
I don't have any issues with the consistency but my point is that in the
modifications of this PR you have:
- 7 times *word* -> _word_
- 1 time (here) _word_ -> *word* (the opposite)
The latter seems weird to me since it breaks the consistency; everything
should be *word* at the end shouldn't it?
—
Reply to this email directly, view it on GitHub
<#37255 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AACVLNLGOC4ZSUQ2V23G3YLWBP52XANCNFSM6AAAAAAQ4IM5TM>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
XhmikosR
force-pushed
the
xmr/markdownlint-fixes
branch
from
cf84fff
to
4db0d7a
Compare
|
I say we land this and we tweak the markdownlint config in my branch for the future. Or, feel free to revert any of the changes you don't like, I don't mind. I mostly want the real fixes, using |
|
BTW there's an action we could use. It's just that we need to find a way to exclude some false positives due to the Hugo markup. |
Just a few things markdownlint caught in https://github.com/twbs/bootstrap/tree/main-xmr-markdownlint
Unfortunately, we can't add markdownlint due to the FPs we are getting due to Hugo.
Also, the rules I went with are lax, I went mostly for consistency, but we could adapt the other branch and then the fixes here.
UNTESTED
Preview: https://deploy-preview-37255--twbs-bootstrap.netlify.app/