Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Windows Usage Clarity #130

Closed
13steinj wants to merge 3 commits into from
Closed

Windows Usage Clarity #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b74155
Update quickstart.rst
13steinj Aug 20, 2015
f148359
Update cli.rst
13steinj Aug 20, 2015
bf55532
Update quickstart.rst
13steinj Aug 20, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Quick Start

2. Run

On Linux/Mac:
.. code::

$ pep257 test.py
Expand All @@ -18,5 +19,27 @@ Quick Start
D102: Docstring missing
...

On Windows:
.. code::

py -m pep257 test.py
test.py:18 in private nested class `meta`:
D101: Docstring missing
test.py:22 in public method `method`:
D102: Docstring missing
...

Note: If you are on Windows and have more than one
Python Environment, e.g. Python 2 and 3, you must run
.. code::

py -2 -m pep257 test.py

for use in Python 2, or
.. code::

py -3 -m pep257 test.py

for us in Python 3
3. Fix your code :)

5 changes: 4 additions & 1 deletion docs/snippets/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ Usage

.. code::

Usage: pep257 [options] [<file|dir>...]
Linux/Mac Usage: pep257 [options] [<file|dir>...]
Windows Usage: py -m pep257 [options] [<file|dir>...]
or: py -2 -m pep257 [options] [<file|dir>...]
or: py -3 -m pep257 [options] [<file|dir>...]

Options:
--version show program's version number and exit
Expand Down