Coder Social home page Coder Social logo

Comments (3)

encukou avatar encukou commented on July 23, 2024

I assume that all docstrings should have valid reStructuredText markup.

That is not the case. What are you basing this assumption on?

from cpython.

stevepiercy avatar stevepiercy commented on July 23, 2024

@encukou https://peps.python.org/pep-0287/

from cpython.

encukou avatar encukou commented on July 23, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.