Skip to content

Commit

Permalink
a few cli docs and message updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mahmoud committed Nov 26, 2023
1 parent 9082ab6 commit 1336a7c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
6 changes: 2 additions & 4 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,15 @@

.. note::

glom's CLI is still under construction. Definitely usable and
useful, but glom is a library *first*, and if you're reading this,
the CLI should not be considered stable.
glom's CLI is usable and useful, but keep in mind glom is a library *first*.


All the power of ``glom``, without even opening your text editor!

.. code-block:: text
$ glom --help
Usage: /home/mahmoud/virtualenvs/glom/bin/glom [FLAGS] [spec [target]]
Usage: /home/mahmoud/bin/glom [FLAGS] [spec [target]]
Command-line interface to the glom library, providing nested data
access and data restructuring with the power of Python.
Expand Down
4 changes: 2 additions & 2 deletions glom/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def mw_handle_target(target_text, target_format):
Args:
target_text (str): The target data to load, as text
target_format (str): Valid formats include `.json`, `.toml`, and `.yml` or `.yaml`
target_format (str): Valid formats include `json`, `toml`, and `yml`/`yaml`
Returns:
The content of the file that you specified
Raises:
Expand Down Expand Up @@ -142,7 +142,7 @@ def mw_handle_target(target_text, target_format):
elif target_format == 'python':
load_func = ast.literal_eval
else:
raise UsageError('expected target-format to be one of python, json, or yaml')
raise UsageError('expected target-format to be one of python, json, toml, or yaml')


try:
Expand Down

0 comments on commit 1336a7c

Please sign in to comment.