Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify usage output between export and reading sections #344

Closed
flight16 opened this issue Apr 12, 2015 · 2 comments · Fixed by #991
Closed

Clarify usage output between export and reading sections #344

flight16 opened this issue Apr 12, 2015 · 2 comments · Fixed by #991
Labels
documentation Improvements or additions to documentation 📌 This can't go stale

Comments

@flight16
Copy link

When reading the usage output, I didn't expect to be able to use --short while reading a journal, but it worked. This makes sense knowing the code, but just from reading the usage it is unexpected.

I think '--short' and '--tags' should be listed under 'Reading' with a note under 'Export' that 'Reading''s options can also be used.

usage: jrnl [-h] [-v] [-ls] [-from DATE] [-until DATE] [-on DATE] [-and]
            [-starred] [-n [N]] [--short] [--tags] [--export TYPE] [-o OUTPUT]
            [--encrypt [FILENAME]] [--decrypt [FILENAME]] [--edit]
            [[...]]

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         prints version information and exits
  -ls                   displays accessible journals

Composing:
  To write an entry simply write it on the command line, e.g. "jrnl
  yesterday at 1pm: Went to the gym."

  

Reading:
  Specifying either of these parameters will display posts of your journal

  -from DATE            View entries after this date
  -until DATE, -to DATE
                        View entries before this date
  -on DATE              View entries on this date
  -and                  Filter by tags using AND (default: OR)
  -starred              Show only starred entries
  -n [N]                Shows the last n entries matching the filter. '-n 3'
                        and '-3' have the same effect.

Export / Import:
  Options for transmogrifying your journal

  --short               Show only titles or line containing the search tags
  --tags                Returns a list of all tags and number of occurences
  --export TYPE         Export your journal. TYPE can be json, markdown, or
                        text.
  -o OUTPUT             Optionally specifies output file when using --export.
                        If OUTPUT is a directory, exports each entry into an
                        individual file instead.
  --encrypt [FILENAME]  Encrypts your existing journal with a new password
  --decrypt [FILENAME]  Decrypts your journal and stores it in plain text
  --edit                Opens your editor to edit the selected entries.
@stale stale bot added the stale label Jul 7, 2019
@mzfr mzfr mentioned this issue Jul 9, 2019
@jrnl-org jrnl-org deleted a comment from stale bot Jul 9, 2019
@wren wren added documentation Improvements or additions to documentation enhancement New feature or request and removed stale labels Jul 9, 2019
@mzfr mzfr mentioned this issue Jul 22, 2019
@stale
Copy link

stale bot commented Aug 8, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Inactive issue: will be closed soon if no activity label Aug 8, 2019
@wren wren added the 📌 This can't go stale label Aug 10, 2019
@stale stale bot removed the stale Inactive issue: will be closed soon if no activity label Aug 10, 2019
@micahellison
Copy link
Member

Relates to #866 - any change to arg parsing is probably going to have an affect on the usage output.

@wren wren closed this as completed in #991 Aug 1, 2020
@wren wren removed the enhancement New feature or request label Nov 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 📌 This can't go stale
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants