Use markdownlint instead of mdformat
#1118
Merged
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
kevinjqliu
commented
Aug 31, 2024
| @@ -117,8 +117,10 @@ This will spin up Docker containers to faciliate running test coverage. | |||
|
|
|||
| Votes are cast by replying to the release candidate announcement email on the dev mailing list with either `+1`, `0`, or `-1`. For example : | |||
|
|
|||
| > \[ \] +1 Release this as PyIceberg 0.3.0 <br> | |||
| > \[ \] +0 <br> | |||
There was a problem hiding this comment.
not allowed by linter, using newline instead
Merged
Fokko
approved these changes
Sep 1, 2024
| @@ -46,17 +46,11 @@ repos: | |||
| hooks: | |||
| - id: pycln | |||
| args: [--config=pyproject.toml] | |||
| - repo: https://github.com/executablebooks/mdformat | |||
| rev: 0.7.17 | |||
| - repo: https://github.com/igorshubovych/markdownlint-cli | |||
There was a problem hiding this comment.
Seems much more popular than mdformat, which is good :)
sungwy
pushed a commit
to sungwy/iceberg-python
that referenced
this pull request
Dec 7, 2024
* use markdownlint * add .markdownlint.yaml * fix make lint * use 4 space indent * fix
sungwy
pushed a commit
to sungwy/iceberg-python
that referenced
this pull request
Dec 7, 2024
* use markdownlint * add .markdownlint.yaml * fix make lint * use 4 space indent * fix
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.
We need to change the markdown linter to run pyiceberg in python 3.12 (see #1068).
mdformatcurrently does not support python 3.12 https://github.com/executablebooks/mdformatmarkdownlintis a suitable replacementAll markdown changes are verified by comparing mkdoc serve with the https://py.iceberg.apache.org/