Giter Site home page Giter Site logo

Update documentation about prompts HOT 3 CLOSED

terkelg avatar terkelg commented on July 22, 2024
Update documentation

from prompts.

Comments (3)

madhavarshney avatar madhavarshney commented on July 22, 2024

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

from prompts.

terkelg avatar terkelg commented on July 22, 2024

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.

from prompts.

terkelg avatar terkelg commented on July 22, 2024

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

from prompts.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.