Skip to content

Commit eb57925

Browse files
Apply suggestions from code review
Co-authored-by: Julien Richard-Foy <[email protected]>
1 parent 2857ccd commit eb57925

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

content/binary-api.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Currently, the compiler automatically generates accessors for references to priv
2828
* Changing the implementation of an inline definition can be a binary incompatible change
2929
* Removing final from a class is a binary incompatible change
3030

31-
You can find more details in https://github.com/lampepfl/dotty/issues/16983
31+
You can find more details in [https://github.com/lampepfl/dotty/issues/16983](https://github.com/lampepfl/dotty/issues/16983)
3232

3333
### Avoid duplication of inline accessors
3434

@@ -44,7 +44,7 @@ There is no precise mechanism to remove a deprecated method from a library witho
4444
+ private[C] def myOldAPI: T = ...
4545
```
4646

47-
Related to discussion in https://github.com/lightbend/mima/discussions/724
47+
Related to discussion in [https://github.com/lightbend/mima/discussions/724](https://github.com/lightbend/mima/discussions/724).
4848

4949
### No way to inline reference to private constructors
5050

@@ -54,7 +54,7 @@ It is currently impossible to refer to private constructors in inline methods. I
5454

5555
### High-level overview
5656

57-
This proposal introduces 2 the `@binaryAPI` and `@binaryAPIAccessor` annotations, and changes adds a migration path to inline methods.
57+
This proposal introduces 2 the `@binaryAPI` and `@binaryAPIAccessor` annotations, and adds a migration path to inline methods.
5858

5959
#### `@binaryAPI` annotation
6060

@@ -165,13 +165,13 @@ final class binaryAPIAccessor extends scala.annotation.StaticAnnotation
165165

166166
* Only valid on `def`, `val`, `lazy val`, `var`, `object`, and `given`.
167167
* TASTy will contain references to non-public definitions that are out of scope but `@binaryAPI`. TASTy already allows those references.
168-
* Annotated definition will be public in the generated bytecode. Definitions should be made public as early as possible in the compiler phases, as this can remove the need to create other accessors. It should be done after we check the accessibility of references.
168+
* The annotated definitions will be public in the generated bytecode. Definitions should be made public as early as possible in the compiler phases, as this can remove the need to create other accessors. It should be done after we check the accessibility of references.
169169

170170

171171
#### `@binaryAPIAccessor` annotation
172172

173173
* Only valid on `def`, `val`, `lazy val`, `var`, `object`, and `given`.
174-
* An public accessor will be generated for the annotated definition. This accessor will be named `<fullClassName>$$inline$<definitionName>`.
174+
* A public accessor will be generated for the annotated definition. This accessor will be named `<fullClassName>$$inline$<definitionName>`.
175175

176176
#### Inline
177177

@@ -221,7 +221,7 @@ This would simplify the system and the user interaction with this feature. The d
221221

222222
## Related work
223223

224-
* Proof of concept: https://github.com/lampepfl/dotty/pull/16992
225-
* Initial discussions: https://github.com/lampepfl/dotty/issues/16983
224+
* Proof of concept: [https://github.com/lampepfl/dotty/pull/16992](https://github.com/lampepfl/dotty/pull/16992)
225+
* Initial discussions: [https://github.com/lampepfl/dotty/issues/16983](https://github.com/lampepfl/dotty/issues/16983)
226226

227227
<!-- ## FAQ -->

0 commit comments

Comments
 (0)