From 6b9004b55f5026716b739e35f42b5874c16607a2 Mon Sep 17 00:00:00 2001 From: Simon Kennedy Date: Sat, 9 Aug 2014 16:53:41 +0100 Subject: Update documentation to match config file location change in last commit. --- docs/intro.rst | 13 +++++++++++-- 1 file 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] -- cgit v1.2.1