summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Kennedy <code@sffjunkie.co.uk>2014-08-09 16:53:41 +0100
committerIan Lee <IanLee1521@gmail.com>2014-12-29 11:18:23 -0800
commit6b9004b55f5026716b739e35f42b5874c16607a2 (patch)
tree4cc07d345cd735bbde3204c1ff5aa32a5e84d94c
parent725e0f221231f422fa4d34cb421c36bbfa5d0d60 (diff)
downloadpep8-6b9004b55f5026716b739e35f42b5874c16607a2.tar.gz
Update documentation to match config file location change in last commit.
-rw-r--r--docs/intro.rst13
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/intro.rst b/docs/intro.rst
index b5e3971..a5da86a 100644
--- a/docs/intro.rst
+++ b/docs/intro.rst
@@ -185,8 +185,17 @@ Configuration
The behaviour may be configured at two levels.
-The user settings are read from the ``~/.config/pep8`` file and
-for Windows from the ``~\.pep8`` file.
+The user settings are read from the following locations:
+
+If on Windows:
+ ``~\.pep8``
+
+Otherwise, if the :envvar:`XDG_CONFIG_HOME` environment variable is defined:
+ ``XDG_CONFIG_HOME/pep8``
+
+Else if :envvar:`XDG_CONFIG_HOME` is not defined:
+ ``~/.config/pep8``
+
Example::
[pep8]