Skip to content

Commit b7b84dd

Browse files
committed
Add references to issues
1 parent d055caa commit b7b84dd

11 files changed

+42
-16
lines changed

docs/docs/reference/adts.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ enum Color(val rgb: Int) {
9696
}
9797
```
9898

99-
## Syntax of Enums
99+
### Syntax of Enums
100100

101101
Changes to the syntax fall in two categories: enum classes and cases inside enums.
102102
The changes are specified below as deltas with respect to the Scala syntax given [here](https://github.com/lampepfl/dotty/blob/master/docs/docs/internals/syntax.md)
@@ -116,7 +116,6 @@ The changes are specified below as deltas with respect to the Scala syntax given
116116
ClsParamClauses TemplateOpt
117117
TemplateStat ::= ... | EnumCaseStat
118118

119+
### Reference
119120

120-
121-
122-
121+
For more info, see [Issue #1970](https://github.com/lampepfl/dotty/issues/1970).

docs/docs/reference/auto-parameter-tupling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@ Generally, a function value with `n > 1` parameters is converted to a
2828
pattern-matching closure using `case` if the expected type is a unary
2929
function type of the form `((T_1, ..., T_n)) => U`.
3030

31+
### Reference
3132

32-
33-
33+
For more info, see [Issue #897](https://github.com/lampepfl/dotty/issues/897).

docs/docs/reference/changed/implicit-conversions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ is no longer legal and has to be rwritten to
4343
val x: B = a // OK
4444
}
4545

46+
### Reference
4647

47-
48+
For more info, see [PR #2065](https://github.com/lampepfl/dotty/pull/2065).
4849

docs/docs/reference/changed/structural-types.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ the cast lies about the structure of the record, the corresponding
102102
likely be part if a database access layer which would ensure its
103103
correctness.
104104

105-
## Notes:
105+
### Notes:
106106

107107
1. The scheme does not handle polymorphic methods in structural
108108
refinements. Such polymorphic methods are currently flagged as
@@ -127,3 +127,7 @@ differences.
127127
takes class tags indicating the method's formal parameter types as
128128
additional argument. `Dynamic` comes with `applyDynamic` and
129129
`updateDynamic` methods, which take actual argument values.
130+
131+
### Reference
132+
133+
For more info, see [Issue #1886](https://github.com/lampepfl/dotty/issues/1886).

docs/docs/reference/desugarEnums.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ comma separated simple cases into a sequence of cases.
138138
Any modifiers or annotations on the original case extend to all expanded
139139
cases.
140140

141-
## Equality
141+
### Equality
142142

143143
An `enum` type contains a `scala.Eq` instance that restricts values of the `enum` type to
144144
be compared only to other values of the same enum type. Furtermore, generic
@@ -147,7 +147,7 @@ be compared only to other values of the same enum type. Furtermore, generic
147147

148148
implicit def eqOption[T, U](implicit ev1: Eq[T, U]): Eq[Option[T], Option[U]] = Eq
149149

150-
## Translation of Enumerations
150+
### Translation of Enumerations
151151

152152
Non-generic enum classes `E` that define one or more singleton cases
153153
are called _enumerations_. Companion objects of enumerations define

docs/docs/reference/enums.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ object Color {
2626
}
2727
```
2828

29-
## Parameterized enums
29+
### Parameterized enums
3030

3131
Enum classes can be parameterized.
3232

@@ -41,7 +41,7 @@ enum Color(val rgb: Int) {
4141
As the example shows, you can define the parameter value by using an
4242
explicit extends clause.
4343

44-
## Methods defined for enums
44+
### Methods defined for enums
4545

4646
The values of an enum correspond to unique integers. The integer
4747
associated with an enum value is returned by its `enumTag` method:
@@ -67,7 +67,7 @@ scala> Color.enumValues
6767
val res3: collection.Iterable[Color] = MapLike(Red, Green, Blue)
6868
```
6969

70-
## User-defined members of enums
70+
### User-defined members of enums
7171

7272
It is possible to add your own definitions to an enum class or its
7373
companion object. To make clear what goes where you need to use the
@@ -101,7 +101,7 @@ object Planet {
101101
}
102102
```
103103

104-
## Implementation
104+
### Implementation
105105

106106
Enum classes are represented as `sealed` classes that extend the `scala.Enum` trait.
107107
This trait defines a single method, `enumTag`:
@@ -137,3 +137,7 @@ definition of value `Color.Red` above would expand to:
137137
```scala
138138
val Red: Color = $new(0, "Red")
139139
```
140+
141+
### Reference
142+
143+
For more info, see [Issue #1970](https://github.com/lampepfl/dotty/issues/1970).

docs/docs/reference/implicit-by-name-parameters.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,7 @@ val s = implicitly[Test.Codec[Option[Int]]](
6262
```
6363

6464
No lazy val was generated because the synthesized argument is not recursive.
65+
66+
### Reference
67+
68+
For more info, see [Issue #1998](https://github.com/lampepfl/dotty/issues/1998.)

docs/docs/reference/implicit-function-types.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,7 @@ With that setup, the table construction code above compiles and expands to:
9797
cell("bottom right")($r)
9898
}($t)
9999
}
100+
101+
### Reference
102+
103+
For more info, see the [blog article](https://www.scala-lang.org/blog/2016/12/07/implicit-function-types.html).

docs/docs/reference/inline.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ overhead:
109109
}
110110
}
111111

112-
## Relationship to `@inline`.
112+
### Relationship to `@inline`.
113113

114114
Existing Scala defines a `@inline` annotation which is used as a hint
115115
for the backend to inline. For most purposes, this annotation is
@@ -125,6 +125,10 @@ it in backticks, i.e.
125125
@`inline` def ...
126126

127127

128+
### Reference
129+
130+
For more info, see [PR #1492](https://github.com/lampepfl/dotty/pull/1492) and
131+
[Scala SIP 28](http://docs.scala-lang.org/sips/pending/inline-meta.html)
128132

129133

130134

docs/docs/reference/multiversal-equality.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,8 @@ The precise rules for equality checking are as follows.
9494
not eligible is successful.
9595

9696
More on multiversal equality is found in a [blog post]
97-
and a [Github issue].
97+
and a [Github issue].
98+
99+
### Reference
100+
101+
For more info, see [Issue #1247](https://github.com/lampepfl/dotty/issues/1247).

docs/docs/reference/trait-parameters.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,6 @@ The correct way to write `E` is to extend both `Greeting` and
5555
class E extends Greeting("Bob") with FormalGreeting
5656
```
5757

58+
### Reference
5859

60+
For more info, see [Scala SIP 25](http://docs.scala-lang.org/sips/pending/trait-parameters.html).

0 commit comments

Comments
 (0)