babel icon indicating copy to clipboard operation
babel copied to clipboard

doc: Missing documentation on configuration

Open Huy-Ngo opened this issue 1 year ago • 2 comments
trafficstars

Overview Description

The page https://babel.pocoo.org/en/latest/messages.html has description of configuration format, however it does not mention the configuration file name anywhere, nor does any other pages.

The current description is also vague on which configuration options and which extractors are supported by default.

Expected Results

The documentation has details of info above.

Huy-Ngo avatar Jan 31 '24 03:01 Huy-Ngo

There is no single configuration filename; you'd use

  -F MAPPING_FILE, --mapping-file=MAPPING_FILE, --mapping=MAPPING_FILE
                        path to the mapping configuration file

to specify one when running a Babel CLI command. This is (admittedly vaguely) documented over at https://babel.pocoo.org/en/latest/setup.html#method-mapping (which is linked to from the page you mention).

Improvement PRs are welcome!

akx avatar Jan 31 '24 07:01 akx

Just putting it here, we should also add documentation for the new TOML config: https://github.com/python-babel/babel/pull/1108

tomasr8 avatar Aug 17 '24 10:08 tomasr8