Skip to content

Fix some mistakes in the Match Types documentation #8706

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

Conversation

iamrecursion
Copy link
Contributor

@iamrecursion iamrecursion commented Apr 10, 2020

  1. Fix a few spelling and grammar errors in the match types documentation.
  2. Add a comment reflecting the work to be done as part of Update documentation on Variance Laws for Match Types #8702 so readers of the documentation do not gain a mistaken understanding of the variance rules for Match Types.
  3. Wraps lines at 80 characters to enable much easier reading of the documentation in its source form.

This isn't associated with any ticket, but just comes from the fact that I'm following the work on match types! It's really cool to see how they're evolving, and I'm interested in getting more involved.

Review by @OlivierBlanvillain

Copy link
Member

@dottybot dottybot left a comment

Choose a reason for hiding this comment

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

Hello, and thank you for opening this PR! 🎉

All contributors have signed the CLA, thank you! ❤️

Have an awesome day! ☀️

@iamrecursion iamrecursion force-pushed the wip/ara/match-types-doc-tweaks branch from 7a8f314 to fceb470 Compare April 10, 2020 17:14
@iamrecursion
Copy link
Contributor Author

I should note that formatting and line wrapping seems to be a bit inconsistent throughout the documentation, so I just went with a sensible default for that. If those changes are unwelcome I'm very happy to revert them and just leave the spelling / grammatical tweaks!

Copy link
Contributor

@OlivierBlanvillain OlivierBlanvillain left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, besides my two comments it all LGTM!

1. Fix a few spelling and grammar errors in the match types
   documentation.
2. Add a comment reflecting the work to be done as part of scala#8702 so
   readers of the documentation do not gain a mistaken understanding of
   the variance rules for Match Types.
3. Wraps lines at 80 characters to enable much easier reading of the
   documentation in its source form.

Review by @OlivierBlanvillain
@iamrecursion iamrecursion force-pushed the wip/ara/match-types-doc-tweaks branch from fceb470 to ba3aa8c Compare April 16, 2020 09:11
@iamrecursion
Copy link
Contributor Author

Fixed!

Thanks for the review, and it's been great to watch all the work on match types. Is there any way I can get involved?

@OlivierBlanvillain OlivierBlanvillain merged commit 1a0a5a2 into scala:master Apr 17, 2020
@OlivierBlanvillain
Copy link
Contributor

OlivierBlanvillain commented Apr 17, 2020

Thanks!

8649 could be a good (match type related) first issue if you want to get your hands in the compiler internals

@iamrecursion iamrecursion deleted the wip/ara/match-types-doc-tweaks branch April 17, 2020 14:09
@iamrecursion
Copy link
Contributor Author

Thanks for the pointer! I think I should have a chance to take a look at it this weekend.

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

Successfully merging this pull request may close these issues.

3 participants