devguide
devguide copied to clipboard
python
The Python developer's guide
I'm not sure if this is controversial or not. It's ready to merge if people like it. ---- 📚 Documentation preview 📚: https://cpython-devguide--1343.org.readthedocs.build/
Discussing this pull request, it was uncontroversial that function signatures should include the slash or star as needed: https://github.com/python/cpython/pull/121197/files ---- 📚 Documentation preview 📚: https://cpython-devguide--1344.org.readthedocs.build/
Prior discussion: - #1337 I opened PR #1337 since I was puzzled that we tell people how to configure and build CPython _before_ we tell them how to install third...
The exception table format is described in https://github.com/python/cpython/blob/main/InternalDocs/exception_handling.md. ---- 📚 Documentation preview 📚: https://cpython-devguide--1334.org.readthedocs.build/
The current devguide [recommendations reads](https://devguide.python.org/documentation/markup/#inline-markup): > backquotes: \`\`text\`\` for code samples, variables, and literals. Earlier, I've been corrected to use double backticks when marking up literals. Example PR remark: -...
**Describe the bug** https://devguide.python.org/documentation/devguide/ says: > Our devguide workflow uses continuous integration and deployment so changes to the devguide are normally published when the pull request is merged. Changes to...
Let's document the method to build docs but only rebuild one or a few files like `make -C Doc html SOURCES=`, it can be much quicker than rebuilding the whole...
I think that Alex summarized the issue pretty well: > In general our policy is currently not to add type hints to standard-library modules in the `Lib/` directory (there are...
Hi python devguide maintainers, I wrote an extension that can compose multiple reStructuredText roles together. I learned from https://github.com/sphinx-doc/sphinx/issues/11745#issuecomment-1888465545 that devguide might need this feature, I hope this PR can...
### Describe the bug Is there a reason we sometimes use three tabs (Linux and Mac separate) and sometimes use two ("Unix/MacOS" as one tab)? ### Screenshots _No response_ ###...