Skip to content

Improve docs #10923

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 10 commits into from
Dec 27, 2020
Merged

Improve docs #10923

merged 10 commits into from
Dec 27, 2020

Conversation

ShapelessCat
Copy link
Contributor

@ShapelessCat ShapelessCat commented Dec 27, 2020

Since in some files I inserted some empty lines to separate code examples and its surrounding context paragraphs,
to check what I changed besides white spaces, please turn on "Hide whitespace changes".

  • Current view of an ordered list in the match-syntax.md is wrong, and I adjust the indentation to fix it.
  • Since NotGiven is new in Scala 3, I think in its example code use the new summon is better than implicitly, and I did this replacement.
  • Add missing with in the declaration of given instances.
  • Use inline instead of final to declare constant expressions.

@michelou
Copy link
Contributor

@ShapelessCat The insertion of empty lines to separate code examples and their surrounding context paragraphs is a good thing IMO. I made a few insertions too, although not systematically as you did. Docs contributors should adopt that rule for future changes.

@liufengyun liufengyun requested a review from michelou December 27, 2020 09:57
Copy link
Contributor

@michelou michelou left a comment

Choose a reason for hiding this comment

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

@liufengyun Ok for me.

@liufengyun
Copy link
Contributor

Thanks for your contribution @ShapelessCat 🎉

@liufengyun liufengyun merged commit 8fab91c into scala:master Dec 27, 2020
@ShapelessCat ShapelessCat deleted the improve-docs branch December 27, 2020 20:29
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