Skip to content

[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

Merged
merged 18 commits into from
May 6, 2017
Merged

[CS2] Docs updates #4536

merged 18 commits into from
May 6, 2017

Conversation

GeoffreyBooth
Copy link
Collaborator

@GeoffreyBooth GeoffreyBooth commented May 2, 2017

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

I 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.

@GeoffreyBooth GeoffreyBooth added this to the 2.0.0 milestone May 2, 2017
@xixixao
Copy link
Contributor

xixixao commented May 2, 2017

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 👍

@GeoffreyBooth
Copy link
Collaborator Author

GeoffreyBooth commented May 2, 2017

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.

@GeoffreyBooth GeoffreyBooth changed the title [WIP][CS2] Docs updates [CS2] Docs updates May 3, 2017
@GeoffreyBooth
Copy link
Collaborator Author

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?

Copy link
Collaborator

@lydell lydell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

@GeoffreyBooth GeoffreyBooth merged commit b28e398 into jashkenas:2 May 6, 2017
@GeoffreyBooth GeoffreyBooth mentioned this pull request May 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants