From 4b741551bb4c2f7579960380f9ede60402bf8cda Mon Sep 17 00:00:00 2001 From: 13steinj <13steinj@users.noreply.github.com> Date: Thu, 20 Aug 2015 18:29:37 -0400 Subject: [PATCH 1/3] Update quickstart.rst --- docs/quickstart.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 02c962a8..4537d4bc 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -9,6 +9,7 @@ Quick Start 2. Run + On Linux/Mac: .. code:: $ pep257 test.py @@ -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 :) From f148359287645a99af85c7d1344ff37a54b9386f Mon Sep 17 00:00:00 2001 From: 13steinj <13steinj@users.noreply.github.com> Date: Thu, 20 Aug 2015 18:40:53 -0400 Subject: [PATCH 2/3] Update cli.rst Added Clarity --- docs/snippets/cli.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/snippets/cli.rst b/docs/snippets/cli.rst index 5bbbfb1c..95e90cd6 100644 --- a/docs/snippets/cli.rst +++ b/docs/snippets/cli.rst @@ -3,7 +3,10 @@ Usage .. code:: - Usage: pep257 [options] [...] + Linux/Mac Usage: pep257 [options] [...] + Windows Usage: py -m pep257 [options] [...] + or: py -2 -m pep257 [options] [...] + or: py -3 -m pep257 [options] [...] Options: --version show program's version number and exit From bf55532bdf3b07440c0591aff9e0e8eadf174660 Mon Sep 17 00:00:00 2001 From: 13steinj <13steinj@users.noreply.github.com> Date: Thu, 20 Aug 2015 18:57:36 -0400 Subject: [PATCH 3/3] Update quickstart.rst --- docs/quickstart.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 4537d4bc..2b4ca8ff 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -29,17 +29,17 @@ Quick Start 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 + 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 + for use in Python 2, or .. code:: py -3 -m pep257 test.py - for us in Python 3 + for us in Python 3 3. Fix your code :)