Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

➖ remove broken mdformat-pyproject #262

Merged
merged 15 commits into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .mdformat.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
end_of_line = "lf"
exclude = [".tox/**", ".venv/**", "**/*.m[!d]", "**/*.[!m]d"]
miloth marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
miloth marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,12 @@ Ensure you have [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
Now you can install the project with the dev dependencies:

```bash
uv sync --frozen
uv sync --frozen --python=3.13
```

> [!NOTE]
> Python 3.13 is required to properly run `mdformat` (see the documentation [note here][mdformat-3.13]).
miloth marked this conversation as resolved.
Show resolved Hide resolved

### pre-commit

`scipy-stubs` uses [pre-commit](https://pre-commit.com/) to ensure that the code is
Expand Down Expand Up @@ -255,3 +258,4 @@ This guide is based on the **contributing-gen**.
[bug]: https://github.com/jorenham/scipy-stubs/issues
[coc]: https://github.com/jorenham/scipy-stubs/blob/master/CODE_OF_CONDUCT.md
[doc]: https://github.com/jorenham/scipy-stubs?tab=readme-ov-file#scipy-stubs
[mdformat-3.13]: https://mdformat.readthedocs.io/en/stable/users/configuration_file.html#exclude-patterns
15 changes: 1 addition & 14 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ lint = [
{include-group = "scipy"},
"mdformat-gfm>=0.3.7,<1",
"mdformat-gfm-alerts>=1.0.1,<2",
"mdformat-pyproject>=0.0.2,<1",
"ruff>=0.8.1,<1",
"sp-repo-review[cli]>=2024.8.19",
]
Expand Down Expand Up @@ -107,15 +106,7 @@ rm -rf
./**/.ruff_cache
./**/.tox
"""
mdformat = """
mdformat
CODE_OF_CONDUCT.md
CONTRIBUTING.md
README.md
SECURITY.md
tests/README.md
codegen/README.md
"""
mdformat = "mdformat ."
miloth marked this conversation as resolved.
Show resolved Hide resolved
_ruff_format = "ruff format"
_ruff_check = "ruff check --show-fixes"
repo-review = "repo-review ."
Expand Down Expand Up @@ -158,10 +149,6 @@ args = [
[tool.typos.files]
extend-exclude = ["*.pyi"]

[tool.mdformat]
end_of_line = "lf"
exclude = [".tox/**", ".venv/**", "**/*.m[!d]", "**/*.[!m]d"]

[tool.mypy]
python_version = "3.10"
strict = true
Expand Down
17 changes: 0 additions & 17 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading