Skip to content

Commit 93a87b0

Browse files
committed
Docs: don't make unnecessary claims
1 parent d3698ee commit 93a87b0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/docs/usage/scala3doc/docComments.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ references the class named `` `immutable.List` `` in package `scala.collection`.
3939
#### New syntax
4040

4141
We have extended Scaladoc definition links to make them a bit more pleasant to
42-
write and read in source. The new syntax features are:
42+
write and read in source. The aim was also to bring the link and Scala syntax
43+
closer together. The new features are:
4344

4445
1. `package` can be used as a prefix to reference the enclosing package
4546
Example:
@@ -53,9 +54,8 @@ write and read in source. The new syntax features are:
5354
def bar = "bar".
5455
}
5556
```
56-
Links to the enclosing package in Scaladoc required mentioning the complete
57-
package name. Using the `package` keyword (similarly to how one would use
58-
`this` in expressions) helps make such links shorter.
57+
The `package` keyword helps make links to the enclosing package shorter
58+
and a bit more resistant to name refactorings.
5959
1. `this` can be used as a prefix to reference the enclosing classlike
6060
Example:
6161
```

0 commit comments

Comments
 (0)