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

Add search option to agenda subcommand; deprecate search subcommand #816

Open
michaelmhoffman opened this issue Nov 15, 2024 · 1 comment

Comments

@michaelmhoffman
Copy link
Collaborator

#813 revealed some confusion on using the search command when really agenda is a better use case. I'm certain the opposite happens as well.

Both of these subcommands are wrappers to GoogleCalendarInterface._display_queried_events(), and both accept start and end positions. Having one agenda subcommand with an option for search that could be used or not would be more ergonomic, simpler to explain, and would eliminate a problem of discoverability and a growing number of subcommands.

Furthermore, having two different subcommands causes duplication of interface code and documentation. Additional options (such as feature request #685) would require either further duplication of code or making the options available for only one of the two commands.

Suggested implementation plan:

  1. implement search option for agenda; mark search as deprecated, have it generate a DeprecationWarning
  2. subsequent release: remove search
@dbarnett
Copy link
Collaborator

+1, I'm totally in favor of consolidating down to fewer top-level commands.

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

No branches or pull requests

2 participants