benya/whipper-gui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #461 from neilmayhew/fix/inline-config-comments

Browse Source 
Restore the ability to use inline comments in config files
This commit is contained in:
JoeLametta
2020-02-04 16:23:55 +01:00
committed by GitHub
parent 87e75d0f98 dca9fcb7dc
commit 3213241ea5
2 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -228,13 +228,13 @@ The configuration file is stored in `$XDG_CONFIG_HOME/whipper/whipper.conf`, or
See [XDG Base Directory
Specification](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html)
and [ConfigParser](https://docs.python.org/3/library/configparser.html).
and [ConfigParser](https://docs.python.org/3/library/configparser.html) with `inline_comment_prefixes=(';')`.
The configuration file consists of newline-delineated `[sections]`
containing `key = value` pairs. The sections `[main]` and
`[musicbrainz]` are special config sections for options not accessible
from the command line interface. Sections beginning with `drive` are
written by whipper; certain values should not be edited.
written by whipper; certain values should not be edited. Inline comments can be added using `;`.
Example configuration demonstrating all `[main]` and `[musicbrainz]`
options: