Skip to content

Commit c915fa7

Browse files
committed
Sketch a style guide entry for future features.
1 parent f3cf92a commit c915fa7

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

Style.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,25 @@ In the reference,
113113
so we don’t also mention methods separately.
114114
In the guide, we write “functions and methods”.
115115

116+
## future features
117+
118+
Starting with the implementation of
119+
[SE-0362: Piecemeal adoption of upcoming language improvements][SE-0362],
120+
some language features are available on an opt-in basis
121+
before being enabled by default.
122+
123+
At the beginning of a section or chapter about a future feature,
124+
include a note as follows.
125+
126+
> Note:
127+
> This language feature will be part of Swift *n*.
128+
> To enable it in current versions of Swift,
129+
> use the feature identifier `SomeFeatureIdentifier`.
130+
> For information about enabling future language features,
131+
> see [Enabling future language features](FIXME).
132+
133+
[SE-0362]: https://github.com/apple/swift-evolution/blob/main/proposals/0362-piecemeal-future-features.md
134+
116135
## headings
117136

118137
Use number signs (`#`) for headings, not underlines.

0 commit comments

Comments
 (0)