From 7cf58785524a7be500f6fa8ef51095470226bfa3 Mon Sep 17 00:00:00 2001 From: Michael Greenberg Date: Tue, 23 Aug 2022 10:07:07 -0400 Subject: [PATCH] readme note, bump version --- README.md | 4 ++++ pyproject.toml | 2 +- setup.py | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b2cbe81..a984246 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/pyproject.toml b/pyproject.toml index 069e94c..a66f117 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "libdash" -version = "0.3" +version = "0.3.1" authors = [ { name="Michael Greenberg", email="michael@greenberg.science" }, ] diff --git a/setup.py b/setup.py index 78501f1..541a899 100644 --- a/setup.py +++ b/setup.py @@ -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,