Skip to content

Fix the overview of the documentation #11334

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 3 commits into from
Feb 22, 2021

Conversation

ShapelessCat
Copy link
Contributor

All changes are in overview.md

  • Adjust indentations
  • Fix links
  • Use up-to-date terms.

Copy link
Contributor

@b-studios b-studios left a comment

Choose a reason for hiding this comment

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

Looks good to me. Though, I would like to understand the motivation of introducing linebreaks everywhere.

- [Type class derivation](contextual/derivation.md) provides an in-language implementation of the `Gen` macro in Shapeless and other foundational libraries. The new implementation is more robust, efficient and easier to use than the macro.
- [Implicit by-name parameters](contextual/by-name-context-parameters.md) provide a more robust in-language implementation of the `Lazy` macro in [Shapeless](https://github.com/milessabin/shapeless).
- [Match Types](new-types/match-types.md)
allow computation on types.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason why you use line breaks here? (Also in other cases above and below)

Copy link
Contributor Author

@ShapelessCat ShapelessCat Feb 8, 2021

Choose a reason for hiding this comment

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

@b-studios
I just want to separate the topic of each entry and their explanations.
The reasons I want to do this:

  1. In the future, for each entry, edit the topics and edit the explanations can be separated in git history because they are in different lines. I notice we changed the terms used to describe the topics before, and this kind of changes may happen in the future again. Change the terms used to describe the topics often doesn't affect the sentences following them. This is why I think separate them to different lines is good.
  2. These new line breaks won't show up when the markdown files are rendered to htmls. Since it won't affect the reading of the docs, I think add them looks ok.

@liufengyun liufengyun requested a review from b-studios February 16, 2021 08:17
Copy link
Contributor

@liufengyun liufengyun left a comment

Choose a reason for hiding this comment

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

LGTM

@liufengyun liufengyun merged commit 1803076 into scala:master Feb 22, 2021
@ShapelessCat ShapelessCat deleted the fix-docs-overview branch March 15, 2021 21:10
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