1j01/textual-paint
1
1
Fork 0
mirror of https://github.com/1j01/textual-paint.git synced 2024-08-17 03:40:26 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update and clarify help text

Browse Source
This commit is contained in:
Isaiah Odhner 2023-07-15 23:05:41 -04:00
parent b62a92a782
commit f6a40028e8
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -103,13 +103,15 @@ options:
--theme {light,dark} Theme to use, either "light" or "dark"
--language {ar,cs,da,de,el,en,es,fi,fr,he,hu,it,ja,ko,nl,no,pl,pt,pt-br,ru,sk,sl,sv,tr,zh,zh-simplified}
Language to use
--ascii-only-icons Use only ASCII characters for tool icons
--ascii-only-icons Use only ASCII characters for tool icons, no emoji or
other Unicode symbols
--backup-folder FOLDER
Folder to save backups to. By default a backup is saved
alongside the edited file.
--inspect-layout Inspect the layout with middle click, for development
--inspect-layout Enables DOM inspector (F12) and middle click highlight,
for development
--clear-screen Clear the screen before starting; useful for
development, to avoid seeing fixed errors
development, to avoid seeing outdated errors
--restart-on-changes Restart the app when the source code is changed, for
development
--recode-samples Open and save each file in samples/, for testing

6
src/textual_paint/paint.py
View File

@ -63,17 +63,17 @@ parser = argparse.ArgumentParser(description='Paint in the terminal.', usage='%(
parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
parser.add_argument('--theme', default='light', help='Theme to use, either "light" or "dark"', choices=['light', 'dark'])
parser.add_argument('--language', default='en', help='Language to use', choices=['ar', 'cs', 'da', 'de', 'el', 'en', 'es', 'fi', 'fr', 'he', 'hu', 'it', 'ja', 'ko', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ru', 'sk', 'sl', 'sv', 'tr', 'zh', 'zh-simplified'])
parser.add_argument('--ascii-only-icons', action='store_true', help='Use only ASCII characters for tool icons')
parser.add_argument('--ascii-only-icons', action='store_true', help='Use only ASCII characters for tool icons, no emoji or other Unicode symbols')
parser.add_argument('--backup-folder', default=None, metavar="FOLDER", help='Folder to save backups to. By default a backup is saved alongside the edited file.')
# TODO: hide development options from help? there's quite a few of them now
parser.add_argument('--inspect-layout', action='store_true', help='Inspect the layout with middle click, for development')
parser.add_argument('--inspect-layout', action='store_true', help='Enables DOM inspector (F12) and middle click highlight, for development')
# This flag is for development, because it's very confusing
# to see the error message from the previous run,
# when a problem is actually solved.
# There are enough ACTUAL "that should have worked!!" moments to deal with.
# I really don't want false ones mixed in. You want to reward your brain for finding good solutions, after all.
parser.add_argument('--clear-screen', action='store_true', help='Clear the screen before starting; useful for development, to avoid seeing fixed errors')
parser.add_argument('--clear-screen', action='store_true', help='Clear the screen before starting; useful for development, to avoid seeing outdated errors')
parser.add_argument('--restart-on-changes', action='store_true', help='Restart the app when the source code is changed, for development')
parser.add_argument('--recode-samples', action='store_true', help='Open and save each file in samples/, for testing')