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

Update documentation #55

Closed
terkelg opened this issue Mar 11, 2018 · 3 comments
Closed

Update documentation #55

terkelg opened this issue Mar 11, 2018 · 3 comments
Labels
enhancement New feature or request

Comments

@terkelg
Copy link
Owner

terkelg commented Mar 11, 2018

Update documentation to reflect v0.1.7

  • stdin and stdout option for all prompts.
  • Tab functionality for initial values in TextPrompt and NumberPrompt.
  • hint in SelectPrompt.
  • float, round and increment in NumberPrompt
  • fallback and initial for AutocompletePrompt
  • emoji renderer option
  • validate option (Coming in next release)
  • Make new gif for autocomplete
  • Make new gif to show filter function
@madhavarshney
Copy link
Contributor

If you can give a quick explanation for these, I can document them.

@terkelg
Copy link
Owner Author

terkelg commented Jun 27, 2018

Sure! We need to update the readme to reflect some new options added to a few prompts:

  • All: stdin/stdout The abstract base prompt class take these as options, but they are not documented in any of the prompts yet.
  • TextPrompt and NumberPrompt: Document new tab interaction where you can hit the tab key to autocomplete default values provided by the initial option.
  • SelectPrompt: There's a new hint option that's a string shown to the user as a placeholder until the user provide input.
  • NumberPrompt: A few new options float boolean, round which is decimals to round a value and increment which is how much to increment when using the arrow keys.
  • AutocompletePrompt: Initial value option and fallback text feature.

If you can document that in the readme (including default values) that would be a huge help. Take a look at the source and the documentation in code (I already updated the JSDocs, like here) to see what they are doing and feel free to ask here too.

@terkelg
Copy link
Owner Author

terkelg commented Jul 12, 2018

@madhavarshney how is it going with the TypeScript definitions and documentation?

@terkelg terkelg added the enhancement New feature or request label Aug 14, 2018
@terkelg terkelg added this to the v1.0.0 milestone Aug 14, 2018
@terkelg terkelg closed this as completed Aug 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants