-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Fix documentation regressions #15170
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
pikinier20
merged 8 commits into
scala:language-reference-stable
from
dotty-staging:scaladoc/hide-pages
May 17, 2022
Merged
Fix documentation regressions #15170
pikinier20
merged 8 commits into
scala:language-reference-stable
from
dotty-staging:scaladoc/hide-pages
May 17, 2022
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2f1a5c5
to
b3e8556
Compare
julienrf
reviewed
May 12, 2022
Syntax 3.1 should not be included in the sidebar. It's a work in progress
that tracks what Scala 3.x without the Scala 2 backwards compatibility
would look like. So I'd like to keep it included so we can update it, but
it would be confusing for readers. That's why it is not linked.
…On Thu, May 12, 2022 at 3:02 PM Julien Richard-Foy ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/_docs/release-notes-0.1.2.md
<#15170 (comment)>:
> [31]: #2136
[32]: #1758
-[33]: ../reference/metaprogramming/inline.html
+[33]: reference/metaprogramming/inline.html
I am surprised that those wrong links were not creating errors before?
------------------------------
In docs/sidebar.yml
<#15170 (comment)>:
> - page: reference/other-new-features/kind-polymorphism.md
- page: reference/other-new-features/matchable.md
- page: reference/other-new-features/threadUnsafe-annotation.md
- page: reference/other-new-features/targetName.md
- page: reference/other-new-features/control-syntax.md
- page: reference/other-new-features/indentation.md
+ - page: reference/other-new-features/indentation-experimental.md
I believe this page should be under the path
reference/experimental/fewer-braces.md. We should also add it to the
stable website, by the way.
------------------------------
In docs/sidebar.yml
<#15170 (comment)>:
> - page: internals/syntax.md
+ - page: internals/syntax-3.1.md
Those files have similar titles, but also similar content. About the
title, I think these files contain more than a summary, it looks like a
specification, so I would say “Scala Syntax Specification”. There is also
the file in reference/syntax.md that is very similar. @odersky
<https://github.com/odersky>, what could we add to the top of
internals/syntax.md and internals/syntax-3.1.md to explain why they
differ from each other, and why they differ from reference/syntax.md?
—
Reply to this email directly, view it on GitHub
<#15170 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAGCKVXH7YM7HIUY6VR4V3TVJT6PFANCNFSM5VXXL4YA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
--
Martin Odersky
Professor, Programming Methods Group (LAMP)
Faculty IC, EPFL
Station 14, Lausanne, Switzerland
|
Syntax 3.1 got removed from the sidebar. |
julienrf
approved these changes
May 16, 2022
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.
Thank you Filip!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request addresses change requests mentioned in: #15099
List of changes:
The best option to review this PR is to go commit-by-commit since one commit addresses one issue from the list above.
I'm going to paste there a link to documentation as soon as the CI uploads it.
EDIT: I'll change the target branch to stable docs - it will be then backported to main after merge