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

Docs/examples for agendaupdate to make it more discoverable #776

Open
dbarnett opened this issue Sep 25, 2024 · 3 comments
Open

Docs/examples for agendaupdate to make it more discoverable #776

dbarnett opened this issue Sep 25, 2024 · 3 comments

Comments

@dbarnett
Copy link
Collaborator

The agendaupdate command could use more help description and pointers to some examples of how to use it, so it's more discoverable to someone looking to solve the problem it's designed to solve.

Currently none of the help seems to mention that you pair it with agenda --tsv to get a TSV file in the right format to use as input for agendaupdate, and the help on the command is in general pretty terse:

$ gcalcli agendaupdate -h
usage: gcalcli agendaupdate [-h] [--calendar CALENDAR] [file]

Update calendar from agenda TSV file.

positional arguments:
  file

options:
  -h, --help           show this help message and exit
  --calendar CALENDAR  Which calendar to use, in the format "CalendarName" or
                       "CalendarName#color", where the #color suffix is the name of a
                       valid ANSI color (such as "brightblue").

Could use an end-to-end example of how to use it somewhere, maybe in README.md and linked from the --help or something.

@dbarnett
Copy link
Collaborator Author

I actually didn't realize it existed or understand what it was used for before digging through the code and the PR adding it.

FYI I'm not sure all the enhancements we talked about on the original issue will all fit logically under the same agendaupdate command, but OTOH I'll want to be careful about splitting out a bunch of command names for related functionality and am considering tweaking the command naming to make it more self-explanatory and make gcalcli --help more conveniently browseable.

@michaelmhoffman
Copy link
Collaborator

There is now a repo at michaelmhoffman/gcaledit showing how one can set up gcalcli agendaagendaupdate workflows.

@michaelmhoffman
Copy link
Collaborator

Renaming the subcommand is probably a good idea.

I think reorganizing the list of subcommands to have several sets of commands, one for reading, one for writing, one for other, would make stuff more discoverable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants