Skip to content

Commit 9e396b0

Browse files
committed
Update configuration documentation; issue #368 / #369
1 parent ed1e25c commit 9e396b0

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

pep8.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1925,7 +1925,15 @@ def get_parser(prog='pep8', version=__version__):
19251925

19261926

19271927
def read_config(options, args, arglist, parser):
1928-
"""Read both user configuration and local configuration."""
1928+
"""Read and parse configurations
1929+
1930+
If a config file is specified on the command line with the "--config"
1931+
option, then only it is used for configuration.
1932+
1933+
Otherwise, the user configuration (~/.config/pep8) and any local
1934+
configurations in the current directory or above will be merged together
1935+
(in that order) using the read method of ConfigParser.
1936+
"""
19291937
config = RawConfigParser()
19301938

19311939
cli_conf = options.config

0 commit comments

Comments
 (0)