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

Dictionary doc #6

Closed
wants to merge 2 commits into from
Closed

Dictionary doc #6

wants to merge 2 commits into from

Conversation

bbenezech
Copy link
Contributor

Thanks for merging PR.
Dictionary doc additions, I tried to stay on topic ;)

Thanks for merging PR.
Dictionary doc additions, I tried to stay on topic ;)
@pelotom
Copy link
Collaborator

pelotom commented Feb 24, 2017

Hm, I feel like this makes the example overly complicated. The example doesn't need to be exhaustive in its use of all the available types, it just needs to get the basic idea across.

What the documentation could really use right now is a section for each type, describing it in isolation and giving an example usage along with the static type that it corresponds to.

@bbenezech
Copy link
Contributor Author

bbenezech commented Feb 24, 2017

I think I would keep examples somewhat feature complete as long as they are the only source of documentation.

Improving the documentation with a feature index may be premature effort-wise:

  • the API is small
  • the example is focused and clear
  • TS makes inferred types self-discoverable

I had no issue at all to get started thanks to the example, but if Dictionary had existed then, I would have wasted time not finding it in the doc and having to look it up in the source.

But you should trust your judgement: DX-wise, this project is simply awesome: API, tests and Readme are absolutely fabulous ❤️

Thanks a lot for your efforts open sourcing this code.
Let me know if you need some help maintaining it in the future.

pelotom added a commit that referenced this pull request Feb 24, 2017
@pelotom
Copy link
Collaborator

pelotom commented Feb 24, 2017

I've added a dictionary to the expanded space-game example in the examples directory. In general, if you want to add examples, big or small, to that directory, I would be more than happy to accept them, because they are not just passive documentation; they get type checked!

Thanks for your kind words and above all for your willingness to contribute!

@pelotom pelotom closed this Feb 24, 2017
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

Successfully merging this pull request may close these issues.

None yet

2 participants