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

More separation for each use case for CLI #40

Closed
ewen-lbh opened this issue Jun 21, 2020 · 1 comment
Closed

More separation for each use case for CLI #40

ewen-lbh opened this issue Jun 21, 2020 · 1 comment
Assignees
Milestone

Comments

@ewen-lbh
Copy link
Owner

ewen-lbh commented Jun 21, 2020

Add one form for each use case in the usage pattern.

As docopt has some difficulties parsing nested optional positional arguments, I had to use ARGUMENTS... but I can still explain the different use cases in a different section, that will not be parsed by docopt:

Use cases: ideaseed is divided into 4 different use cases:
    Creating an issue
    $ ideaseed --issue [-T TITLE] [[OWNER/]REPO [PROJECT [COLUMN]]] IDEA [-@ ASSIGNEE...] [-# LABEL...] [-M MILESTONE] [options]
    
    Creating a project card
    $ ideaseed [[OWNER/]REPO [PROJECT [COLUMN]]] IDEA [options]
    
    Creating a project card on your GitHub profile
    # (replace "keyword" and "project" with actual values)
    $ ideaseed --user-keyword keyword --user-project project keyword [COLUMN] IDEA [options]
    # It is worth noting that --user-keyword and --user-project are values that you'll not change often,
    # so it's worth putting them in your alias and not having to type them out each time, for example:
    $ alias idea="ideaseed --user-keyword keyword --user-project project"
    $ idea keyword example
    
    Creating a Google Keep card
    $ ideaseed IDEA [-c COLOR] [-# LABEL...] [--pin] [options]

(This block of code asusmes #28, #42 and #43 have been resolved)

@ewen-lbh ewen-lbh self-assigned this Jun 21, 2020
@ewen-lbh ewen-lbh changed the title More separation between forms for CLI More separation for each use case for CLI Jun 21, 2020
@ewen-lbh ewen-lbh added this to the 1.0.0 milestone Jun 22, 2020
@ewen-lbh
Copy link
Owner Author

ewen-lbh commented Apr 4, 2021

Closed by 0f86a87

@ewen-lbh ewen-lbh closed this as completed Apr 4, 2021
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

1 participant