Skip to content

Commit

Permalink
Update links to use scala/scala3 instead of lampepfl/dotty
Browse files Browse the repository at this point in the history
  • Loading branch information
hamzaremmal committed Mar 1, 2024
1 parent 187863b commit a68fdd6
Show file tree
Hide file tree
Showing 41 changed files with 84 additions and 84 deletions.
4 changes: 2 additions & 2 deletions _ja/scala3/contribute-to-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ Scala 3 コンパイラとライブラリへの貢献と内部に関する包括
## Scala 3 Language Reference
The [Dotty reference]({{ site.scala3ref }}/overview.html) は Scala 3 になる予定である。これにはさまざまな言語仕様に関する公式のプレゼンテーションや技術的情報が含まれている。

- [Sources](https://github.com/lampepfl/dotty/tree/main/docs/_docs)
- [Issues](https://github.com/lampepfl/dotty/issues)
- [Sources](https://github.com/scala/scala3/tree/main/docs/_docs)
- [Issues](https://github.com/scala/scala3/issues)


[scala3-book]: {% link _overviews/scala3-book/introduction.md %}
2 changes: 1 addition & 1 deletion _overviews/FAQ/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ tool you are using. For sbt, add it to `.jvmopts`.
If the stack overflow doesn't go away no matter how much stack you
give the compiler, then it's a compiler bug. Please report it on the
[Scala 2 bug tracker](https://github.com/scala/bug/issues) or [Scala 3
bug tracker](https://github.com/lampepfl/dotty/issues), but check
bug tracker](https://github.com/scala/scala3/issues), but check
first if it's a duplicate of an existing ticket.

### I set a setting in sbt but nothing happened. Why?
Expand Down
2 changes: 1 addition & 1 deletion _overviews/compiler-options/optimizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ However, even when staying within these constraints, some changes performed by t
- Inlined methods disappear from call stacks.

- This can lead to unexpected behaviors when using a debugger.
- Related: line numbers (stored in bytecode) are discarded when a method is inlined into a different classfile, which also impacts debugging experience. (This [could be improved](https://github.com/scala/scala-dev/issues/3) and is expected to [progress](https://github.com/lampepfl/dotty/pull/11492).)
- Related: line numbers (stored in bytecode) are discarded when a method is inlined into a different classfile, which also impacts debugging experience. (This [could be improved](https://github.com/scala/scala-dev/issues/3) and is expected to [progress](https://github.com/scala/scala3/pull/11492).)

- Inlining a method can delay class loading of the class where the method is defined.

Expand Down
2 changes: 1 addition & 1 deletion _overviews/contribute/bug-reporting-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Bug Reporting Guide
num: 8
---

The Scala compiler and standard library bug tracker is located at [https://github.com/scala/bug](https://github.com/scala/bug), and for Scala 3, it is located at [github.com/lampepfl/dotty](https://github.com/lampepfl/dotty/issues). Before you submit a bug make sure that it is certainly a bug by following instructions
The Scala compiler and standard library bug tracker is located at [https://github.com/scala/bug](https://github.com/scala/bug), and for Scala 3, it is located at [github.com/scala/scala3](https://github.com/scala/scala3/issues). Before you submit a bug make sure that it is certainly a bug by following instructions
in [Is it a Bug?](#is-it-a-bug).

## Is it a Bug?
Expand Down
2 changes: 1 addition & 1 deletion _overviews/contribute/codereviews.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ own pull requests.
<div class="container">
<div class="row">
<div class="span4 doc-block">
<h4><a href="https://github.com/scala/scala/pulls">lampepfl/dotty</a></h4>
<h4><a href="https://github.com/scala/scala3/pulls">scala/scala3</a></h4>
<p>Scala 3 bug fixes and changes in the language, core libs and included tools.</p>
</div>
<div class="span4 doc-block">
Expand Down
2 changes: 1 addition & 1 deletion _overviews/contribute/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ unencumbered by copyrights or patents.

### Bug-fix Check List
> Originally these steps cover the [Scala 2 compiler](https://github.com/scala/scala), but they also are relevant to
> the [Scala 3 compiler](https://github.com/lampepfl/dotty).
> the [Scala 3 compiler](https://github.com/scala/scala3).
This is the impatient developer's checklist for the steps to submit a bug-fix pull request to the Scala project. For more information, description and justification for the steps, follow the links in that step. Further specific instructions for the release of Scala you are targeting can be found in the `CONTRIBUTING.md` file for that [GitHub branch](https://github.com/scala/scala)

Expand Down
8 changes: 4 additions & 4 deletions _overviews/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ scala_resources:
icon: fa fa-bug
link: /contribute/guide.html
- title: Code Reviews
description: "Review pull requests against scala/scala, lampepfl/dotty, scala/scala-lang, scala/docs.scala-lang, and others."
description: "Review pull requests against scala/scala, scala/scala3, scala/scala-lang, scala/docs.scala-lang, and others."
icon: fa fa-eye
link: /contribute/codereviews.html
- title: Core Libraries
Expand Down Expand Up @@ -109,7 +109,7 @@ In the spree, regular project maintainers will mentor you to create your first c

### So you want to improve the Scala 3 compiler...

The [Scala 3 compiler](https://github.com/lampepfl/dotty) is an open source project.
The [Scala 3 compiler](https://github.com/scala/scala3) is an open source project.
If you are curious about contributing but don't know how to begin, the [Scala Center](https://scala.epfl.ch)
runs the **Scala Compiler Academy** project to onboard and educate new people to the project. You can join the regular
**Issue Spree**, watch in-depth videos, and read the contributing guide:
Expand All @@ -119,7 +119,7 @@ runs the **Scala Compiler Academy** project to onboard and educate new people to
#### Which areas are perfect for newcomers?
- Adding new linting options, which help enforce cleaner code.
- Improving the clarity of error messages, so that the user understands better what went wrong.
- Add IDE quick-fix actions to error messages, e.g. PR [lampepfl/dotty#18314](https://github.com/lampepfl/dotty/pull/18314).
- Add IDE quick-fix actions to error messages, e.g. PR [scala/scala3#18314](https://github.com/scala/scala3/pull/18314).

### So you want to write a library...

Expand Down Expand Up @@ -162,7 +162,7 @@ When contributing, please follow:

### Community tickets

All issues can be found in the [Scala bug tracker](https://github.com/scala/bug), or the [Scala 3 issue tracker](https://github.com/lampepfl/dotty/issues). Most issues are labeled
All issues can be found in the [Scala bug tracker](https://github.com/scala/bug), or the [Scala 3 issue tracker](https://github.com/scala/scala3/issues). Most issues are labeled
to make it easier to find issues you are interested in.

### Tools and libraries
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ package objects for important packages (these often get overlooked for documenta
and are a good place for API overviews).

If you find an issue, please log it in the [Scala bug tracker](https://github.com/scala/bug),
(or else the [Scala 3 issue tracker](https://github.com/lampepfl/dotty/issues) for Scala 3 library additions)
(or else the [Scala 3 issue tracker](https://github.com/scala/scala3/issues) for Scala 3 library additions)
**after making sure it is not already logged as an issue**. To help with
disambiguation, please use the following format for issue title:

Expand Down
4 changes: 2 additions & 2 deletions _overviews/scala3-migration/incompat-other-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ class C extends B // In Scala 3, Error: class C needs to be abstract, since def
{% endtab %}
{% endtabs %}

This behavior was decided in [Dotty issue #4770](https://github.com/lampepfl/dotty/issues/4770).
This behavior was decided in [Dotty issue #4770](https://github.com/scala/scala3/issues/4770).

An easy fix is simply to remove the abstract def, since in practice it had no effect in Scala 2.

Expand Down Expand Up @@ -264,7 +264,7 @@ val pojo = new Pojo()

A type of the form `=> T` cannot be used as an argument to a type parameter anymore.

This decision is explained in [this comment](https://github.com/lampepfl/dotty/blob/0f1a23e008148f76fd0a1c2991b991e1dad600e8/compiler/src/dotty/tools/dotc/core/ConstraintHandling.scala#L144-L152) of the Scala 3 source code.
This decision is explained in [this comment](https://github.com/scala/scala3/blob/0f1a23e008148f76fd0a1c2991b991e1dad600e8/compiler/src/dotty/tools/dotc/core/ConstraintHandling.scala#L144-L152) of the Scala 3 source code.

For instance, it is not allowed to pass a function of type `Int => (=> Int) => Int` to the `uncurried` method since it would assign `=> Int` to the type parameter `T2`.

Expand Down
2 changes: 1 addition & 1 deletion _overviews/scala3-migration/incompat-type-checker.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Scala 3 being based on stronger theoretical foundations, these unsoundness bugs
## Unsoundness Fixes in Variance checks

In Scala 2, default parameters and inner-classes are not subject to variance checks.
It is unsound and might cause runtime failures, as demonstrated by this [test](https://github.com/lampepfl/dotty/blob/10526a7d0aa8910729b6036ee51942e05b71abf6/tests/neg/variances.scala) in the Scala 3 repository.
It is unsound and might cause runtime failures, as demonstrated by this [test](https://github.com/scala/scala3/blob/10526a7d0aa8910729b6036ee51942e05b71abf6/tests/neg/variances.scala) in the Scala 3 repository.

The Scala 3 compiler does not permit this anymore.

Expand Down
14 changes: 7 additions & 7 deletions _overviews/scala3-migration/scaladoc-settings-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ previous-page: options-new
next-page: plugin-intro
---

The current page is stating the status of scaladoc settings. The related Github issue can be found here for [discussion](https://github.com/lampepfl/dotty/issues/11907)
The current page is stating the status of scaladoc settings. The related Github issue can be found here for [discussion](https://github.com/scala/scala3/issues/11907)


| Scala2 | Scala3 | Description | Comment | Is implemented?
| ------------- | ------------- | --- | --- | --- |
| -doc-format | _ | Selects in which format documentation is rendered. | Actually, old scaladoc supports only html, so it is in some way consistent with new scaladoc, which provides only html | <i class="fa fa-times fa-lg"></i> |
| -doc-title | -project | The overall name of the Scaladoc site | Aliased in [#11965](https://github.com/lampepfl/dotty/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -doc-version | -project-version | | Aliased in [#11965](https://github.com/lampepfl/dotty/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -doc-footer | -project-footer | A footer on every Scaladoc page, by default the EPFL/Lightbend copyright notice. Can be overridden with a custom footer. | Fixed by [#11965](https://github.com/lampepfl/dotty/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -doc-title | -project | The overall name of the Scaladoc site | Aliased in [#11965](https://github.com/scala/scala3/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -doc-version | -project-version | | Aliased in [#11965](https://github.com/scala/scala3/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -doc-footer | -project-footer | A footer on every Scaladoc page, by default the EPFL/Lightbend copyright notice. Can be overridden with a custom footer. | Fixed by [#11965](https://github.com/scala/scala3/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -doc-no-compile | _ | A directory containing sources which should be parsed for docstrings without compiling (e.g. AnyRef.scala) | We don't need this as we have completely different approach to that issue using -Ydocument-synthetic-types flag for synthetic types | <i class="fa fa-check fa-lg"></i> |
| -doc-source-url | -source-links | A URL pattern used to link to the source file, with some variables supported... | Scala3 implementation provides richer syntax. You can find migration steps below this [table](#source-links). | <i class="fa fa-check fa-lg"></i> |
| -doc-external-doc | -external-mappings | Links describing locations of external dependencies' documentations. | Scala3 implementation provides richer syntax. You can find migration steps below this [table](#external-mappings). | <i class="fa fa-check fa-lg"></i> |
Expand All @@ -34,16 +34,16 @@ The current page is stating the status of scaladoc settings. The related Github
| -diagrams-max-implicits | _ | | We don't need this in Scala3 | <i class="fa fa-times fa-lg"></i> |
| -diagrams-dot-timeout | _ | | We don't need this in Scala3 | <i class="fa fa-times fa-lg"></i> |
| -diagrams-dot-restart | _ | | We don't need this in Scala3 | <i class="fa fa-times fa-lg"></i> |
| -author | -author | | Fixed by [#11965](https://github.com/lampepfl/dotty/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -author | -author | | Fixed by [#11965](https://github.com/scala/scala3/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -raw-output | _ | | We don't need this in Scala3 | <i class="fa fa-check fa-lg"></i> |
| -no-prefixes | _ | | We don't need this in Scala3 | <i class="fa fa-check fa-lg"></i> |
| -skip-packages | -skip-packages | | | <i class="fa fa-check fa-lg"></i> |
| -no-link-warnings | _ | | Not implemented yet | <i class="fa fa-times fa-lg"></i> |
| -expand-all-types | _ | | Setting has been removed | <i class="fa fa-times fa-lg"></i> |
| -groups | -groups | | | <i class="fa fa-check fa-lg"></i> |
| -no-java-comments | _ | | We don't need this in Scala3 | <i class="fa fa-check fa-lg"></i> |
| -doc-canonical-base-url | -doc-canonical-base-url | A base URL to use as prefix and add `canonical` URLs to all pages. The canonical URL may be used by search engines to choose the URL that you want people to see in search results. If unset no canonical URLs are generated. | Fixed by [#11965](https://github.com/lampepfl/dotty/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -private | -private | Show all types and members. Unless specified, show only public and protected types and members. | Fixed by [#11965](https://github.com/lampepfl/dotty/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -doc-canonical-base-url | -doc-canonical-base-url | A base URL to use as prefix and add `canonical` URLs to all pages. The canonical URL may be used by search engines to choose the URL that you want people to see in search results. If unset no canonical URLs are generated. | Fixed by [#11965](https://github.com/scala/scala3/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| -private | -private | Show all types and members. Unless specified, show only public and protected types and members. | Fixed by [#11965](https://github.com/scala/scala3/issues/11965) | <i class="fa fa-check fa-lg"></i> |
| _ | -siteroot | | We don't backport it to old scaladoc | N/A |
| _ | -project-logo | | Should we backport it to the old scaladoc? | N/A |
| _ | -comment-syntax | | We don't backport it to the old scaladoc | N/A |
Expand Down
2 changes: 1 addition & 1 deletion _overviews/scala3-migration/tooling-migration-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Scala 3 compiler provides some helpful utilities to ease the migration.

Try running `scalac` to have a glimpse of those utilities:

> `scalac` is the executable of the Scala compiler, it can be downloaded from [Github](https://github.com/lampepfl/dotty/releases/).
> `scalac` is the executable of the Scala compiler, it can be downloaded from [Github](https://github.com/scala/scala3/releases/).
>
> It can also be installed using Coursier with `cs install scala3-compiler`, in which case `scalac` is aliased `scala3-compiler`.
Expand Down
2 changes: 1 addition & 1 deletion _overviews/scala3-scaladoc/docstrings.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ In the example above, this Scaladoc comment is associated with the method square
Scaladoc comments can go before fields, methods, classes, traits, objects.
For now, scaladoc doesn't support straightforward solution to document packages. There is a dedicated github
[issue](https://github.com/lampepfl/dotty/issues/11284), where you can check the current status of the problem.
[issue](https://github.com/scala/scala3/issues/11284), where you can check the current status of the problem.
For class primary constructors which in Scala coincide with the definition of the class itself, a @constructor tag is used to target a comment to be put on the primary constructor documentation rather than the class overview.
Expand Down
6 changes: 3 additions & 3 deletions _overviews/scala3-scaladoc/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This chapter lists the configuration options that can be used when calling scala
## Parity with scaladoc for Scala 2

Scaladoc has been rewritten from scratch and some of the features turned out to be useless in the new context.
If you want to know what is current state of compatibility with scaladoc old flags, you can visit this issue for tracking [progress](https://github.com/lampepfl/dotty/issues/11907).
If you want to know what is current state of compatibility with scaladoc old flags, you can visit this issue for tracking [progress](https://github.com/scala/scala3/issues/11907).

## Providing settings

Expand Down Expand Up @@ -49,7 +49,7 @@ Revision (branch or ref) used to build project. Useful with sourcelinks to preve
Source links provide a mapping between file in documentation and code repository.

Example source links is:
`-source-links:docs=github://lampepfl/dotty/master#docs`
`-source-links:docs=github://scala/scala3/main#docs`

Accepted formats:

Expand Down Expand Up @@ -87,7 +87,7 @@ A mapping is of the form `<regex>::[scaladoc3|scaladoc|javadoc]::<path>`. You ca

Links to social sites. For example:

`-social-links:github::https://github.com/lampepfl/dotty,discord::https://discord.com/invite/scala,twitter::https://twitter.com/scala_lang`
`-social-links:github::https://github.com/scala/scala3,discord::https://discord.com/invite/scala,twitter::https://twitter.com/scala_lang`

Valid values are of the form: `[github|twitter|gitter|discord]::link`. Scaladoc also supports `custom::link::white_icon_name::black_icon_name`. In this case icons must be present in `images/` directory.

Expand Down
4 changes: 2 additions & 2 deletions _ru/scala3/contribute-to-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ language: ru
## Справочник по языку Scala 3
[Справочник по Scala 3]({{ site.scala3ref }}) содержит формальное представление и подробную техническую информацию о различных возможностях языка.

- [Исходники](https://github.com/lampepfl/dotty/tree/main/docs/_docs)
- [Вопросы](https://github.com/lampepfl/dotty/issues)
- [Исходники](https://github.com/scala/scala3/tree/main/docs/_docs)
- [Вопросы](https://github.com/scala/scala3/issues)


[scala3-book]: {% link _overviews/scala3-book/introduction.md %}
2 changes: 1 addition & 1 deletion _ru/scala3/guides/scaladoc/docstrings.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Scaladoc расширяет возможности Markdown дополнител
Комментарии Scaladoc могут идти перед полями, методами, классами, трейтами, объектами.
На данный момент scaladoc не поддерживает прямое решение для документирования пакетов.
На гитхабе есть специальный [issue](https://github.com/lampepfl/dotty/issues/11284), где вы можете проверить текущий статус проблемы.
На гитхабе есть специальный [issue](https://github.com/scala/scala3/issues/11284), где вы можете проверить текущий статус проблемы.
Для первичных конструкторов класса, которые в Scala совпадают с определением самого класса,
тег @constructor используется для указания комментария, помещаемого в документацию первичных конструкторов, а не в обзор класса.
Expand Down
Loading

0 comments on commit a68fdd6

Please sign in to comment.