search

Stewori / pytypes

Typing-toolbox for Python 3 _and_ 2.7 w.r.t. PEP 484.
Apache License 2.0
200 stars 20 forks source link

add a "quickstart" or similar to the documentation #83

Closed zevaverbach closed 4 years ago

zevaverbach commented 4 years ago

Thanks for the intriguing tool, @Stewori! I want to get acquainted with it but am a little stymied by the README: Are you open to having an animated gif at the top of that document demonstrating pytypes' basic functionality, and/or a "quickstart" with a code block showing similar content? I'd be happy to take a crack at creating it, if this is something you want.

Stewori commented 4 years ago

First of all, thanks a lot for offering help! That said, I am a bit skeptical if an animated gif wouldn't cause too much noise in the document. Given that the tool works in rather text-based fashion, maybe it would be sufficient to stick to text documentation. To judge this idea better, could you help me understand in what way you find the readme insufficient? E.g. I used to think that https://github.com/Stewori/pytypes#usage-python-3 or https://github.com/Stewori/pytypes#usage-example would do the job of getting users started with the core functionality. (Note that my actual intention of pytypes is to create a typing toolbox where these use cases are just proofs of concept of the tooling.) Can you outline what information would go into a quickstart section beyond the info I linked?

Finally, you may have noticed that there exists only a quick-manual. Adding a proper manual or wiki pages is a long-standing todo, but other issues keep me occupied.

Stewori commented 4 years ago

(closing because of inactivity)