Skip to content

Conversation

@kevinjqliu
Copy link
Contributor

@kevinjqliu kevinjqliu commented Aug 31, 2024

We need to change the markdown linter to run pyiceberg in python 3.12 (see #1068).

mdformat currently does not support python 3.12 https://github.com/executablebooks/mdformat
markdownlint is a suitable replacement

All markdown changes are verified by comparing mkdoc serve with the https://py.iceberg.apache.org/

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>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


not allowed by linter, using newline instead

@kevinjqliu kevinjqliu marked this pull request as ready for review August 31, 2024 13:07
@kevinjqliu kevinjqliu mentioned this pull request Aug 31, 2024
args: [--config=pyproject.toml]
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.17
- repo: https://github.com/igorshubovych/markdownlint-cli
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems much more popular than mdformat, which is good :)

@kevinjqliu kevinjqliu merged commit dc6d242 into apache:main Sep 1, 2024
@kevinjqliu kevinjqliu deleted the kevinjqliu/md-format branch September 1, 2024 14:32
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants