voussoir/etiquette
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve some helptext examples.

Browse source
This commit is contained in:
voussoir 2021-09-12 21:20:18 -07:00
parent 068775cedd
commit 93da1f32c7
No known key found for this signature in database
GPG key ID: 5F7554F8C26DACCB
1 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
frontends/etiquette_cli.py
View file

@ -541,22 +541,30 @@ TO SEE DETAILS ON EACH COMMAND, RUN
SUB_DOCSTRINGS = dict(
add_tag='''
add_tag:
Add a tag to files by a filename glob.
Add a tag to photos by a filename glob or by search results.
> etiquette_cli.py add_tag tag_name glob_pattern
> etiquette_cli.py add_tag tag_name glob_patterns
> etiquette_cli.py add_tag tag_name --search searchargs
Examples:
> etiquette_cli.py add_tag wallpaper wall*.jpg
> etiquette_cli.py add_tag wallpaper wall*.jpg wall*.png
> etiquette_cli.py add_tag author.author_voussoir --search --tag-forbids author
See etiquette_cli.py search --help for more info about searchargs.
'''.strip(),
remove_tag='''
remove_tag:
Remove a tag from files by a filename glob.
Remove a tag from photos by a filename glob or by search results.
> etiquette_cli.py remove_tag tag_name glob_pattern
> etiquette_cli.py remove_tag tag_name glob_patterns
> etiquette_cli.py remove_tag tag_name --search searchargs
Examples:
> etiquette_cli.py remove_tag watchlist spongebob*.mp4
> etiquette_cli.py remove_tag watchlist --search --tag-musts directed_by_michael_bay
See etiquette_cli.py search --help for more info about searchargs.
'''.strip(),
delete='''
@ -668,6 +676,9 @@ generate_thumbnail:
> etiquette_cli.py generate_thumbnail --photos id id id
> etiquette_cli.py generate_thumbnail searchargs
Examples:
> etiquette_cli.py generate_thumbnail --search --has-thumbnail no
See etiquette_cli.py search --help for more info about searchargs.
'''.strip(),