-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
[docs/reference] more fixes in Markdown files #10953
Conversation
- [Trait Parameters](other-new-features/trait-parameters.md) replace [early initializers](dropped-features/early-initializers.md) with a more generally useful construct. | ||
- [Given Instances](contextual/givens.md) | ||
- [Trait parameters](other-new-features/trait-parameters.md) replace [early initializers](dropped-features/early-initializers.md) with a more generally useful construct. | ||
- [Given instances](contextual/givens.md) | ||
replace implicit objects and defs, focussing on intent over mechanism. | ||
- [Using Clauses](contextual/using-clauses.md) replace implicit parameters, avoiding their ambiguities. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using Clauses --> Using clauses
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using Clauses --> Using clauses
Done (6bc9dd0).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
added attribute {.scala} to verbatim text (just as with fenced code blocks)
Is it an extension of markdown that is supported by the doc tool? If the motivation is for generating PDF, it seems simpler to assume {.scala}
as the default, and only add the attribute if it's different.
|
I think it's an improvement, thanks for your typography expertise to improve the quality of the doc. For fenced blocks, I'd like to suggest interpret them as Scala code by default if no language is specified. This way, fenced code and inline code also align in syntax. |
The reference documentatiom also contains EBNF grammar in fenced code blocks and a language attribute |
@liufengyun I decided to postpone the addition of the Let us handle it in another PR. |
LGTM |
@abgruszecki Can you please validate your review for this PR and switch to Issue #11014. Thanks. |
Follow up of PR #10767, #10826, #10860 and #10875.
Fixes more issues found in Markdown files in
docs/reference/
, e.g,{.scala}
to verbatim text (just as with fenced code blocks)dropped-features/nonlocal-returns.html
.PS. The above changes can also be viewed in the PDF document
scala3_reference.pdf
(888 Kb) generated with Pandoc 2.11 in ~40 seconds.