Comments (3)
I assume that all docstrings should have valid reStructuredText markup.
That is not the case. What are you basing this assumption on?
from cpython.
@encukou https://peps.python.org/pep-0287/
from cpython.
Thanks. I see where the confusion is coming from.
PEP 287 is an informational PEP, that is:
Informational PEPs do not necessarily represent a Python community consensus or recommendation, so users and implementers are free to ignore Informational PEPs or follow their advice.
And that PEP itself says (although in places obvious that aren't obvious now -- the PEP predates both Sphinx and Markdown):
-
reStructuredText is being proposed as a standard, not the only standard. Its use will be entirely optional.
-
The current policy for docstrings in the Python standard library is that they should be no more than concise hints, simple and markup-free (although many do contain ad-hoc implicit markup).
I'll close this issue, but join the doc-sig mailing list and ask about the PEP there.
from cpython.
Related Issues (20)
- PrettyPrint needs a config argument so output does not re-escape backslashes. If I print var it has single \ HOT 2
- multiprocessing child segfault when passing lock as an argument HOT 3
- Python 3.12 docs website search results prioritizes "what's new" instead of actual topic HOT 6
- ``test_monitoring`` leaks references HOT 1
- REPL takes extra key presses on long inputs that wrap around lines HOT 1
- ZipFile.extractall() extracts to similarly named directories instead of the name of the zipfile HOT 8
- pyrepl always has `from __future__ import annotations` on HOT 1
- Python 3.12.3 installer does not update py.exe in c:\windows HOT 6
- 1506-007 (S) "struct _dtoa_state" is undefined on AIX HOT 2
- Some builtin single phase modules do get loaded into subinterpreters which do not support them HOT 3
- Out-of-memory when reading a HTTP response with large Content-Lenght
- OOM vulnerability in the CGI server on Windows HOT 3
- Invalid escape sequences raise SyntaxWarning HOT 3
- [Windows]: High DPI causes Tools/unittestgui(PyUnit) window blurry HOT 3
- test_socket: testStream() fails on Fedora Rawhide HOT 4
- Python 3.13b repeatedly setting superclass attribute in subclass leads to crashes HOT 20
- Py_buffer.format declaration inconsistent with the docs HOT 3
- test_pyrepl leaks references HOT 4
- Tier Two Optimizer Eliminate Function Version Guards
- Optimize through symbolic tuples in tier 2 optimizer
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 cpython.