Merged
Conversation
pymarkdown provides checks for properly written markdown files. It's quite configurable and checks for many items we choose not to enforce, such as 80 character line length. It can be configured so a CI system could do checks on markdown files being submitted in a PR, but for now, I'm just including the tool in the the list of packages installed from pypi and a script to call it (checkmd.sh) with some settings that limit what checks we're interested in (for now). Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
dbkinder
requested review from
chensuyue,
chickenrae,
ftian1,
mkbhanda,
preethivenkatesh and
tomlenth
as code owners
preethivenkatesh
approved these changes
Sep 6, 2024
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.
pymarkdown provides checks for properly written markdown files. It's quite configurable and checks for many items we choose not to enforce, such as 80 character line length. It can be configured so a CI system could do checks on markdown files being submitted in a PR, but for now, I'm just including the tool in the list of packages installed from PyPI and a script to call it (scripts/checkmd.sh) with some settings that limit what checks we're interested in (for now).