Comments (5)
PR welcome. We don't do anything special for this file, so changing this would require some investigation into how our docs stack generates headers.
from black.
Took a look, but not sure what's the issue here.
Funny enough, only the changelog page seem to have this problem.
Others seem fine e.g. https://black.readthedocs.io/en/latest/getting_started.html#installation
Also, if I add v
in front of the version number in CHANGES.md
e.g. ## v24.4.2
,
then the anchor is correct - #v24-4-2
.
If I add text at the end e.g. ## 24.4.2 - this is weird
then the anchor is #this-is-weird
.
Maybe there's some leading number stripping going on in Sphinx? 🤔
Because this doesn't seem like a MyST parser issue.
🤷
Seems like pip
had a similar problem, but they have a special plugin for including the changelog even 😅 - https://github.com/pypa/pip/blob/3f3bc6000c512abfd518f6b200383451d020f7d8/docs/pip_sphinxext.py#L48-L70.
from black.
I'd be open to changing the headers to something like "Version 24.4.2".
from black.
@JelleZijlstra cool. Can you point me to a place where the "Unreleased" section of CHANGES.md gets turned into the version number after the release?
from black.
https://github.com/psf/black/blob/main/scripts/release.py
from black.
Related Issues (20)
- Black not deleting unnecessary brackets HOT 3
- Cannot format f-strings where the contents re-use the same quotes as the enclosing f-string HOT 1
- 24.4.2: pytest fails in tests/test_format.py with `AssertionError` HOT 3
- Cannot parse multiline f-string containing multiline string HOT 1
- Unnecessary parentheses added to expression in indexed assignment
- "EOF in multi-line string" on string containing same quote nested in f-string HOT 2
- Failure to format when double-quotes are in an f-string's code block HOT 8
- Long lines that concatenate list comprehensions HOT 3
- Black Formatter not working for this code. HOT 2
- Python 3.12 `def f[T: Generics](...)` HOT 2
- Strings not being formatted by Black HOT 3
- Black fails to format string which has '='s etc HOT 2
- Black v24.4.1 & v24.4.2 fails to format f-strings containing multi-line strings HOT 4
- Advice (UFMT) command-failed Failed due to ASTSafetyError HOT 2
- fmt: skip is required at the line which follows the one incorrectly formatted
- Error in github actions when using `use_pyproject: true` HOT 2
- Error: Invalid value for 'SRC ...': Path '...' does not exist. HOT 2
- Technical doc for smoother contribution
- import asyncio HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from black.