[Documentation] Markdown improvements t to z #14371
Conversation
Signed-off-by: Jerome Luckenbach <[email protected]>
Signed-off-by: Jerome Luckenbach <[email protected]>
Signed-off-by: Jerome Luckenbach <[email protected]>
Signed-off-by: Jerome Luckenbach <[email protected]>
Signed-off-by: Jerome Luckenbach <[email protected]>
Signed-off-by: Jerome Luckenbach <[email protected]>
Signed-off-by: Jerome Luckenbach <[email protected]>
Confectrician
requested review from
mhilbush,
miloit,
claell,
davidgraeff,
zarusz,
coop-git,
pavel-gololobov,
clinique,
BoBiene,
Skinah,
CSchlipp,
marcelrv,
hmerk,
jlaur,
grro,
lolodomo,
jamesmelville,
Jamstah,
mlobstein,
steand,
jannegpriv and
t2000
as code owners
| | threePhasedLSMGroup#smaxsn*X*Minus1 | `Number:Power` | Maximum withdrawn apparent power on the previous day on phase *X*, *X* in {1,2,3} | | ||
| | threePhasedLSMGroup#smaxs*X*nDate | `DateTime` | Timestamp of SMAXSN*X* value, *X* in {1,2,3} | | ||
| | threePhasedLSMGroup#smaxsn*X*Minus1Date | `DateTime` | Timestamp of SMAXSN*X*-1 value, *X* in {1,2,3} | | ||
| | threePhasedLSMGroup#irms_X_ | `Number:ElectricCurrent` | RMS Current on phase _X, X_ in {2,3} | |
There was a problem hiding this comment.
Here and in the next rows: I think intention here was to underline each X individually without the comma?
There was a problem hiding this comment.
This is on purpose as is now.
I have tried several options to make this pass markldown linting and also keep the existing intention from the old markup.
There was a problem hiding this comment.
I would like to resolve this, if you don't see any bigger issue with this.
From the rich diff here in the PR it looks quite good.
We can check it anyway after merging and see how vuepress will render this in the next homepage.
There was a problem hiding this comment.
Let's merge this, it's not that important, just wanted to check if intentional from a formatting perspective, since I don't know exactly what triggers the linting. 🙂
There was a problem hiding this comment.
One thing though, can we have the alignment of this table as well as the previous/next tables restored?
There was a problem hiding this comment.
I have committed alignment fixes.
|
LGTM tacmi. Thank you! |
|
Think it is a good idea to not leave this PR hanging too long because it has the potential to cause many merge conflicts :-/ |
|
@Confectrician, did you have a chance to look into the comments? There is also a conflict to resolve. |
Signed-off-by: Jerome Luckenbach <[email protected]> Co-authored-by: Jacob Laursen <[email protected]>
Signed-off-by: Jerome Luckenbach <[email protected]>
|
Sorry for the delay @jlaur. Ready for the next round or merge, when already suitable. |
Signed-off-by: Jacob Laursen <[email protected]>
Signed-off-by: Jacob Laursen <[email protected]>
Signed-off-by: Jacob Laursen <[email protected]>
* Apply markdown fixes for bindings with letter _t_ * Apply markdown fixes for bindings with letter _u_ * Apply markdown fixes for bindings with letter _v_ * Apply markdown fixes for bindings with letter _w_ * Apply markdown fixes for bindings with letter _x_ * Apply markdown fixes for bindings with letter _y_ * Apply markdown fixes for bindings with letter _z_ Signed-off-by: Jerome Luckenbach <[email protected]>
This is a bulk pr for getting some consistency into the doc markdown files.
Reference for a general linting approach here: #13858
Discussion Reference for codeblock styles i have applied: openhab/openhab-docs#999
(Sorry again for the many review requests, there is plenty much to improve in the repo. 🤷♂️)