search

typed-typings / npm-ramda

TypeScript's type definitions for Ramda
MIT License
384 stars 64 forks source link

Examples/docs #259

Open ahstro opened 7 years ago

ahstro commented 7 years ago

It would be great if npm-ramda had a docs page, similar (or identical) to Ramda's docs, but with examples of how to use different type signatures. It could be as simple as forking ramda/ramda.github.io and adding type signatures to the examples.

KiaraGrouwstra commented 7 years ago

I wonder what the relevant considerations here are. As in, if a function supports both list and object inputs, might it suffice to just demo both in the original Ramda docs?

ahstro commented 7 years ago

Not sure I understand what you're saying? I'm talking about creating examples for explicit type signatures.

KiaraGrouwstra commented 7 years ago

Fair enough, thanks for clarifying. Wish things would 'just work' without explicit annotations. But yeah.

bloadvenro commented 7 years ago

@ahstro how should it look like? I do not clearly understand what is meant by "examples of how to use different type signatures". Official ramda docs provide Hindley-Milner type signatures like a → [a] → [a], [k] → [{k: v}] → [{k: v}] and usage examples. Can you please provide some examples of your vision?