-
Notifications
You must be signed in to change notification settings - Fork 2k
[CS2] Docs updates #4536
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
[CS2] Docs updates #4536
Conversation
…f undefined or null
…r things so that the sections on functions come just before classes, and destructuring goes next to the operators (which discuss assignment)
…xplanatory; move practical info into “Usage”
…ect reference to Ruby (fixes jashkenas#2360), add missing details about the safety wrapper, add note about `let`/`const`.
…s into separate sidebar items and files
One thing I noticed while trying the new docs, while it's awesome that the examples are editable! the page is quite slow and janky. It might be because of all these editors or for many other reasons. Compare scrolling through the current page vs the new one. Thanks for all your hard work 👍 |
Yeah I’m pretty sure it’s because of all the editors. It’s a sacrifice I’m willing to make 😄 though maybe we could make them read-only on mobile sizes. Pull requests welcome 😉 Another thought is to initialize Codemirror only when the user clicks into the code, so that we only initialize the editors we need to. |
Any other notes? @lydell or @jashkenas? @connec I updated the classes docs to reflect that bound methods are no longer allowed. Anyone familiar with the Node API who can verify that I've documented it correctly? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome!
I’m trying to close all the open tickets regarding documentation, and make general docs improvements in preparation for 2.0.0-beta2. See live: https://rawgit.com/GeoffreyBooth/coffeescript/docs/docs/v2/index.html
if item not in items
#3281: Add exampleif item not in items
from
and the JS equivalent forin
extends
keyword for function prototypesI closed #2039, about comprehensions, as the docs as written matched it almost word for word. I guess someone forgot to close it after the docs were updated sometime long ago.