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

Mega-list of documentation ideas #2197

Open
jamiebuilds opened this Issue Aug 5, 2016 · 2 comments

Comments

Projects
None yet
2 participants
@jamiebuilds
Contributor

jamiebuilds commented Aug 5, 2016

This list is never going to be truly complete, but I wanted to publicly document all the things I've been making note of that need to be done.

I'll keep adding to this for awhile...

@avikchaudhuri

This comment has been minimized.

Contributor

avikchaudhuri commented Aug 6, 2016

Small comment on "magic" types: they are magic precisely because they're not very well-designed...they are used carefully in the libs to enable us to express some stuff, but often are not very reliable when used in more general contexts. Some of them have definitely reached graduation age, though.

We could of course document them as is, but need to put disclaimers around their general use.

@jamiebuilds

This comment has been minimized.

Contributor

jamiebuilds commented Aug 9, 2016

Should the "graduation" age ones be marked as such somehow? Like $Keys<T> could become Keys<T>?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment