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.

Sign up for GitHub

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

Jump to bottom

Blacken-docs removes lines at beginning and end of codeblocks, thereby destroying the rst #217

Closed
jpfeuffer opened this issue Feb 1, 2023 · 3 comments · Fixed by #271
Closed

Blacken-docs removes lines at beginning and end of codeblocks, thereby destroying the rst #217

jpfeuffer opened this issue Feb 1, 2023 · 3 comments · Fixed by #271

Comments

@jpfeuffer
Copy link

Python Version

3.10

Package Version

1.13

Description

image
@jpfeuffer
Copy link
Author

Probably when the first line is a comment.

@jpfeuffer
Copy link
Author

No, it happens when the empty line between the code-block and your actual code contains the same amount of spaces as the rest of the code.
In theory, this is allowed by rst. Therefore I think Blacken-docs should handle this.

@adamchainz adamchainz mentioned this issue Aug 16, 2023
Merged
@adamchainz
Copy link
Owner

Thanks for digging into your report, I found a fix in #271.

paddyroddy pushed a commit to paddyroddy/python-template that referenced this issue Aug 16, 2023
@renovate
Update pre-commit hook adamchainz/blacken-docs to v1.16.0 (#61)
d25aacc 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[adamchainz/blacken-docs](https://togithub.com/adamchainz/blacken-docs)
| repository | minor | `1.15.0` -> `1.16.0` |

Note: The `pre-commit` manager in Renovate is not supported by the
`pre-commit` maintainers or community. Please do not report any problems
there, instead [create a Discussion in the Renovate
repository](https://togithub.com/renovatebot/renovate/discussions/new)
if you have any questions.

---

### Release Notes

<details>
<summary>adamchainz/blacken-docs (adamchainz/blacken-docs)</summary>

###
[`v1.16.0`](https://togithub.com/adamchainz/blacken-docs/blob/HEAD/CHANGELOG.rst#1160-2023-08-16)

[Compare
Source](https://togithub.com/adamchainz/blacken-docs/compare/1.15.0...1.16.0)

-   Allow Markdown fence options.

Thanks to initial work from Matthew Anderson in `PR #&#8203;246
<https://github.com/adamchainz/blacken-docs/pull/246>`\__.

- Expand Markdown detection to all Python language names from Pygments:
`py`, `sage`, `python3`, `py3`, and `numpy`.

-   Preserve leading whitespace lines in reStructuredText code blocks.

Thanks to Julianus Pfeuffer for the report in `Issue #&#8203;217
<https://github.com/adamchainz/blacken-docs/issues/217>`\__.

- Use exit code 2 to indicate errors from Black, whilst exit code 1
remains for “files have been formatted”.

Thanks to Julianus Pfeuffer for the report in `Issue #&#8203;218
<https://github.com/adamchainz/blacken-docs/issues/218>`\__.

- Support passing the `--preview` option through to Black, to select the
future style.

-   Remove `language_version` from `.pre-commit-hooks.yaml`.
This change allows `default_language_version` in
\`\`.pre-commit-config.yaml\` to take precedence.

Thanks to Aneesh Agrawal in `PR #&#8203;258
<https://github.com/adamchainz/blacken-docs/pull/258>`\__.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/paddyroddy/python-template).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi40My4yIiwidXBkYXRlZEluVmVyIjoiMzYuNDMuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
paddyroddy pushed a commit to astro-informatics/sleplet that referenced this issue Aug 29, 2023
@renovate
Update pre-commit hook adamchainz/blacken-docs to v1.16.0 (#192)
c6dc158 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[adamchainz/blacken-docs](https://togithub.com/adamchainz/blacken-docs)
| repository | minor | `1.15.0` -> `1.16.0` |

Note: The `pre-commit` manager in Renovate is not supported by the
`pre-commit` maintainers or community. Please do not report any problems
there, instead [create a Discussion in the Renovate
repository](https://togithub.com/renovatebot/renovate/discussions/new)
if you have any questions.

---

### Release Notes

<details>
<summary>adamchainz/blacken-docs (adamchainz/blacken-docs)</summary>

###
[`v1.16.0`](https://togithub.com/adamchainz/blacken-docs/blob/HEAD/CHANGELOG.rst#1160-2023-08-16)

[Compare
Source](https://togithub.com/adamchainz/blacken-docs/compare/1.15.0...1.16.0)

-   Allow Markdown fence options.

Thanks to initial work from Matthew Anderson in `PR #&#8203;246
<https://github.com/adamchainz/blacken-docs/pull/246>`\__.

- Expand Markdown detection to all Python language names from Pygments:
`py`, `sage`, `python3`, `py3`, and `numpy`.

-   Preserve leading whitespace lines in reStructuredText code blocks.

Thanks to Julianus Pfeuffer for the report in `Issue #&#8203;217
<https://github.com/adamchainz/blacken-docs/issues/217>`\__.

- Use exit code 2 to indicate errors from Black, whilst exit code 1
remains for “files have been formatted”.

Thanks to Julianus Pfeuffer for the report in `Issue #&#8203;218
<https://github.com/adamchainz/blacken-docs/issues/218>`\__.

- Support passing the `--preview` option through to Black, to select the
future style.

-   Remove `language_version` from `.pre-commit-hooks.yaml`.
This change allows `default_language_version` in
\`\`.pre-commit-config.yaml\` to take precedence.

Thanks to Aneesh Agrawal in `PR #&#8203;258
<https://github.com/adamchainz/blacken-docs/pull/258>`\__.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/astro-informatics/sleplet).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi40My4yIiwidXBkYXRlZEluVmVyIjoiMzYuNDMuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Preserve leading whitespace lines in rST adamchainz/blacken-docs
2 participants
@adamchainz @jpfeuffer