Skip to content

Commit

Permalink
readme note, bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
mgree committed Aug 23, 2022
1 parent 567dd61 commit 7cf5878
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,7 @@ The pretty printer does its best to produce valid shell scripts, but it's possib
For example, the Python AST `[[['Q', [['C', 34]]]]]` represents a quoted field containing a double quote character. Translated literally, this would yield the string `"""`, which is not a valid shell script. The pretty printer will instead automatically escape the inner quote, rendering `"\""`.

While the printer tries to get things right either way, you should use escapes to signal to the printer when to escape: you should use the Python AST `[[['Q', [['E', 34]]]]]` to mark the inner double quote as escaped.

# Known issues

We currently do not escape the character `!` (exclamation point). In an interactive shell, `!` is likely treated as a history substitution (and so should be escaped), but in a non-interactive shell, `!` is treated normally. We currently cater to non-interactive shells; eventually this behavior will be controllable.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "libdash"
version = "0.3"
version = "0.3.1"
authors = [
{ name="Michael Greenberg", email="[email protected]" },
]
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def run(self):
setup(name='libdash',
packages=['libdash'],
cmdclass={'build_py': libdash_build_py},
version='0.3',
version='0.3.1',
long_description=long_description,
long_description_content_type='text/markdown',
include_package_data=True,
Expand Down

0 comments on commit 7cf5878

Please sign in to comment.