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

Mechanisms for more useful usage text #3

Open
vitling opened this issue Mar 27, 2020 · 1 comment
Open

Mechanisms for more useful usage text #3

vitling opened this issue Mar 27, 2020 · 1 comment

Comments

@vitling
Copy link
Owner

vitling commented Mar 27, 2020

I see two main areas to improve

  1. Allow FieldParsers to be self-describing, so they can give hints as to the format in which they expect input.
  2. Field-level annotations to add a wordier description.

I'd say (1) is highest priority, as it creates benefit for the general case; whereas (2) increases the complexity of the API and only helps in specific cases. Both should probably be possible though.

@vitling
Copy link
Owner Author

vitling commented Mar 31, 2020

Actually did (2) first, via the Hint mechanism

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