File: quickstart.rst

package info (click to toggle)
pydocstyle 6.3.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 776 kB
  • sloc: python: 5,183; makefile: 162
file content (24 lines) | stat: -rw-r--r-- 508 bytes parent folder | download | duplicates (4) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
Quick Start
===========

1. Install

    .. code::

        pip install pydocstyle

2. Run

    .. code::

        $ 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)
        ...

3. Fix your code :)