Code Monkey home page Code Monkey logo

pydocstyle's Introduction

pydocstyle - docstring style checker

Documentation Status https://pepy.tech/badge/pydocstyle https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 Gitpod ready-to-code

pydocstyle is a static analysis tool for checking compliance with Python docstring conventions.

pydocstyle supports most of PEP 257 out of the box, but it should not be considered a reference implementation.

pydocstyle supports Python 3.6+.

Quick Start

Install

pip install pydocstyle

Run

$ pydocstyle test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:27 in public function `get_user`:
    D300: Use """triple double quotes""" (found '''-quotes)
test:75 in public function `init_database`:
    D201: No blank lines allowed before function docstring (found 1)
...

Develop

You can use Gitpod to run pre-configured dev environment in the cloud right from your browser -

Open in Gitpod

Before submitting a PR make sure that you run make all.

Links

pydocstyle's People

Contributors

nurdok avatar shacharoo avatar samj1912 avatar dpursehouse avatar andrewsomething avatar jensrantil avatar lordmauve avatar glennmatthews avatar larsoner avatar sigmavirus24 avatar tjanson avatar jayvdb avatar ziadsawalha avatar hugovk avatar hanaasagi avatar ruro avatar theyuvalraz avatar varunagrawal avatar cclauss avatar artloder avatar the-compiler avatar toroettg avatar scop avatar brbsix avatar peterjc avatar justinludwig avatar julianhille avatar thejcannon avatar aphedges avatar asottile avatar

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.