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

Rewrite tour of Scala #733

Closed
33 tasks done
travissarles opened this issue Mar 16, 2017 · 9 comments
Closed
33 tasks done

Rewrite tour of Scala #733

travissarles opened this issue Mar 16, 2017 · 9 comments
Assignees

Comments

@travissarles
Copy link
Contributor

travissarles commented Mar 16, 2017

I'm rewriting most of the tour of Scala. However some guides may not be as relevant like XML processing. Thoughts? @heathermiller

The tour
More info on the rewrite

Current status:

When rewriting the tour, the goals should be to:

  1. Get people up and running as quickly as possible
  2. Be concise without omitting key information
  3. Provide enough information so readers can stay on the page and not have to look up a bunch of terminology
  4. Cater to readers coming from various popular programming languages and not just Java
  5. Don't use language features in examples that haven't been covered yet
  6. Try to use examples that might be used in production but not at the expense of clarity
  7. Read the comments to figure out where people are confused
  8. Link to other pages when it could be helpful

Be sure to add a "prerequisite-knowledge" metadata field to the top of the file. Once the tour is rewritten, we'll use this to make sure there are no forward-references.

@SethTisue
Copy link
Member

In general, I encourage you to be bold about proposing renaming, merging, and dropping sections. I think there is a lot of room for improvement there.

@travissarles
Copy link
Contributor Author

Yes, I think some of the names are overly complicated and specific

@heathermiller
Copy link
Member

Woohoo! @mhzajac has contributed the rewritten variance tour. Thank you! @mhzajac, I'll ask around for reviews 🙂

@mhzajac
Copy link

mhzajac commented Mar 22, 2017

I can try to grab another off the pile. Maybe extractors?

@travissarles
Copy link
Contributor Author

@mhzajac Sure! That would be great. I'll put your name next to it on the ticket.

@travissarles
Copy link
Contributor Author

@mhzajac will you still be able to do the extractors section? I'm trying to wrap things up today. Thanks again for your help.

@mhzajac
Copy link

mhzajac commented Apr 4, 2017

@travissarles Sorry, I'd planned to work on it last week but fell short on spare time. I was going to try again in the latter half of this week, but if you're looking to wrap it up today, I'll have to give it up.

@travissarles
Copy link
Contributor Author

Thanks for the variances section.

@SethTisue
Copy link
Member

the last PR still left over from Travis's efforts has been merged 🎉

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

No branches or pull requests

4 participants