CI: use pymarkdownlnt - #1502
Open
mgovers wants to merge 19 commits into
Open
Conversation
mgovers
added
documentation
mgovers
commented
Jul 28, 2026
mgovers
force-pushed
the
pgm/feature/pymarkdownlnt
branch
2 times, most recently
from
July 28, 2026 13:49
b765f65 to
8435022
Compare
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> update workflows Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> remove markdownlint-cli from devcontainer Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> fix pre-commit Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> more fixes Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> more fixes Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> homogenize Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> fix pyproject.toml Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> minor Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> no run locked (scoped out of pr) Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> fix ci Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> scope out npm packages from refresher Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com> Refresh lock and linter dependencies Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> fix Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
mgovers
force-pushed
the
pgm/feature/pymarkdownlnt
branch
from
July 28, 2026 14:19
048d6ba to
38a2b6a
Compare
mgovers
commented
Jul 28, 2026
Comment on lines
+366
to
+370
| <!-- pyml disable commands-show-output--> | ||
| ```powershell | ||
| $env:CMAKE_PREFIX_PATH = C:\conda_envs\cpp_pkgs\Library | ||
| ``` | ||
| <!-- pyml enable commands-show-output--> |
Member
Author
There was a problem hiding this comment.
some kind of weird false positive where a $ is interpreted as unix $, not as Windows $
mgovers
marked this pull request as ready for review
July 28, 2026 14:22
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…k-and-linter Refresh lock and linter dependencies
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…k-and-linter Refresh lock and linter dependencies
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
mgovers
force-pushed
the
pgm/feature/pymarkdownlnt
branch
from
July 30, 2026 05:34
56c0d4d to
5857ad6
Compare
mgovers
commented
Jul 30, 2026
|
|
||
| 2. If neither `p_sigma` nor `q_sigma` are provided, `power_sigma` represents the standard deviation of the apparent | ||
| power. In this case, infinite value of `power_sigma` disables the entire measurement. | ||
| <!-- pyml enable line-length--> |
Member
Author
There was a problem hiding this comment.
Suggested change
| <!-- pyml enable line-length--> |
mgovers
commented
Jul 30, 2026
Comment on lines
+210
to
+212
| plugins.line-length.line_length = 120 | ||
| plugins.line-length.heading_line_length = 120 | ||
| plugins.line-length.code_block_line_length = 120 |
Member
Author
There was a problem hiding this comment.
TODO: check if we can disable line length on code blocks and tables. if not, then disable entirely
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Member
|
Some 3 markdownlint ignores are present in the docs. Would you do a global find on them? |
mgovers
force-pushed
the
pgm/feature/pymarkdownlnt
branch
from
August 3, 2026 09:13
e7c23dd to
1cfd263
Compare
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
mgovers
force-pushed
the
pgm/feature/pymarkdownlnt
branch
from
August 3, 2026 09:14
1cfd263 to
26e32d1
Compare
|
figueroa1395
reviewed
Aug 3, 2026
figueroa1395
left a comment
figueroa1395
left a comment
Member
There was a problem hiding this comment.
I see the potential issues were addressed. The remaining "exception" blocks from the linter are acceptable to me: only long equations and graphs, as far as I can tell.
The table issue has been resolved.
LGTM.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In light of recent events, we are aiming to reduce our amount of dependencies - in particular the
npmones. That means we need to migrate to a markdown linter in the PyPI ecosystem.Relates to #1499 and #1501 .
Important things to note:
<!-- pyml disable line-length-->and<!-- pyml enable line-length-->.