Fix readme #48
Merged
Fix readme #48
Conversation
This file contains 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
mdformat has a known issue where it will escape brackets (to become literals) when it encounters GitHub-Flavored Markdown extensions: hukkin/mdformat#359 (comment) It is also fairly agressive in ways that, on net, probably reduce readability in ASCII form. Swap automation in favor of pymarkdown, configured identically as in GoogleCloudPlatform/hpc-toolkit. This hook will be disabled until all markdown files honor the linter
mr0re1
approved these changes
Feb 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Commit 87960d0 addresses failure of integration test from mdformat. It inadvertently introduced a known bug in mdformat:
hukkin/mdformat#359 (comment)
This PR swaps out mdformat for pymarkdown, which is already used in GoogleCloudPlatform/hpc-toolkit and re-formats the existing notices in line with pymarkdown. Future commits to README.md should pass linting tests.