Giter Site home page Giter Site logo

Comments (9)

JensRantil avatar JensRantil commented on July 4, 2024

Could you elaborate with an example?

from pydocstyle.

keleshev avatar keleshev commented on July 4, 2024

Forbid """ Foo bar.""", require """Foo bar.""".

from pydocstyle.

marc2982 avatar marc2982 commented on July 4, 2024

What about trailing whitespace in a one-line comment, i.e. """Foo bar. """? It should probably be forbidden as well.

from pydocstyle.

keleshev avatar keleshev commented on July 4, 2024

@marc2982 yes.

from pydocstyle.

merwok avatar merwok commented on July 4, 2024

Leading spaces are indeed not pretty, but I think the PEP allows a blank line, e.g.:

def spam():
    """
    Docstring.
    """

from pydocstyle.

dolph avatar dolph commented on July 4, 2024

This was implemented as D210 and released in 0.5.0 (March 14th, 2015).

#95

from pydocstyle.

merwok avatar merwok commented on July 4, 2024

Does the change forbid the example from my previous message?

from pydocstyle.

Nurdok avatar Nurdok commented on July 4, 2024

@merwok D210 would allow your example, but D200 ("One-line docstring should fit on one line with quotes") would not. So, if you want docstrings in the style of your example, you would need to ignore D200.

from pydocstyle.

merwok avatar merwok commented on July 4, 2024

Yes, imagine a multi-line docstring for that example. Thanks for the reply.

from pydocstyle.

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.