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

Documentation Nomenclature #983

Closed
slashwhatever opened this Issue Sep 28, 2016 · 5 comments

Comments

Projects
None yet
5 participants
@slashwhatever

The way the docs for Immutable.js are written is difficult to understand for many JS developers.

Can you explain the nomenclature used so we can all more easily decipher the documentation and put this framework to more effective use?

@aj07

This comment has been minimized.

Show comment
Hide comment
@aj07

aj07 Sep 28, 2016

Yo are most welcome to contribute. :)

aj07 commented Sep 28, 2016

Yo are most welcome to contribute. :)

@slashwhatever

This comment has been minimized.

Show comment
Hide comment
@slashwhatever

slashwhatever Sep 29, 2016

I'd love to. My point is, I don't understand the docs to begin with and therefore can't contribute.

I'd love to. My point is, I don't understand the docs to begin with and therefore can't contribute.

@awv-inf

This comment has been minimized.

Show comment
Hide comment
@awv-inf

awv-inf Oct 3, 2016

Same problem. It looks like C++/Boost. It's just not expected for a dynamically typed language and it makes it harder to parse. In some (most?) cases i have not the slightest idea what is meant, and there are few usecases or examples. I wish it would be documented as virtually all other js projects are, like lodash, etc. I really wonder, why was this even necessary?

awv-inf commented Oct 3, 2016

Same problem. It looks like C++/Boost. It's just not expected for a dynamically typed language and it makes it harder to parse. In some (most?) cases i have not the slightest idea what is meant, and there are few usecases or examples. I wish it would be documented as virtually all other js projects are, like lodash, etc. I really wonder, why was this even necessary?

@tsironis

This comment has been minimized.

Show comment
Hide comment
@tsironis

tsironis Nov 15, 2016

I totally agree, and also there are no real world example that you can wrap your head around them.

I really like Underscore's documentation and subsequently, lodash and it helped understand both how the library works and made me better developer.

I totally agree, and also there are no real world example that you can wrap your head around them.

I really like Underscore's documentation and subsequently, lodash and it helped understand both how the library works and made me better developer.

@leebyron

This comment has been minimized.

Show comment
Hide comment
@leebyron

leebyron Mar 4, 2017

Collaborator

The documentation function types are written in typescript to help explain how various methods work.

Some but not all documentation contains examples. If you wish, adding examples and improving documentation is an excellent way to contribute back to open source software.

All documentation for this library is automatically generated from https://github.com/facebook/immutable-js/blob/master/type-definitions/Immutable.d.ts which should make contributions easier

Collaborator

leebyron commented Mar 4, 2017

The documentation function types are written in typescript to help explain how various methods work.

Some but not all documentation contains examples. If you wish, adding examples and improving documentation is an excellent way to contribute back to open source software.

All documentation for this library is automatically generated from https://github.com/facebook/immutable-js/blob/master/type-definitions/Immutable.d.ts which should make contributions easier

@leebyron leebyron closed this Mar 4, 2017

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