Skip to content

Commit fa6ff73

Browse files
committed
Track 'main' to resolve merge conflict.
2 parents 7a10094 + 5d59eea commit fa6ff73

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2802
-2396
lines changed

.git-blame-ignore-revs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,6 @@
1616

1717
# Convert RST to markdown.
1818
96f0925407c6bd9eadd9d58d253bad3e1ef7a9f2
19+
20+
# Convert the formal grammar to markdown.
21+
4039ee0ef4e69d2cf6460861f9444a499503db16

.git-order-file

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# This file lists the chapters of TSPL, in the order they appear in the
2+
# book. When reviewing changes, the diff can be easier to read when it
3+
# appears in this order.
4+
#
5+
# To use this file for single command, run a command like the following:
6+
#
7+
# git log -O .git-order-file
8+
# git diff -O .git-order-file
9+
#
10+
# To use it for all diffs, run the following command:
11+
#
12+
# git config --local diff.orderFile .git-order-file
13+
#
14+
# For more information, see the git-log(1) and git-diff(1) man pages'
15+
# discussions of the -O option, and the git-config(1) man page's
16+
# discussion of diff.orderFile option.
17+
18+
TSPL.docc/GuidedTour/AboutSwift.md
19+
TSPL.docc/GuidedTour/Compatibility.md
20+
TSPL.docc/GuidedTour/GuidedTour.md
21+
22+
TSPL.docc/LanguageGuide/TheBasics.md
23+
TSPL.docc/LanguageGuide/BasicOperators.md
24+
TSPL.docc/LanguageGuide/StringsAndCharacters.md
25+
TSPL.docc/LanguageGuide/CollectionTypes.md
26+
TSPL.docc/LanguageGuide/ControlFlow.md
27+
TSPL.docc/LanguageGuide/Functions.md
28+
TSPL.docc/LanguageGuide/Closures.md
29+
TSPL.docc/LanguageGuide/Enumerations.md
30+
TSPL.docc/LanguageGuide/ClassesAndStructures.md
31+
TSPL.docc/LanguageGuide/Properties.md
32+
TSPL.docc/LanguageGuide/Methods.md
33+
TSPL.docc/LanguageGuide/Subscripts.md
34+
TSPL.docc/LanguageGuide/Inheritance.md
35+
TSPL.docc/LanguageGuide/Initialization.md
36+
TSPL.docc/LanguageGuide/Deinitialization.md
37+
TSPL.docc/LanguageGuide/OptionalChaining.md
38+
TSPL.docc/LanguageGuide/ErrorHandling.md
39+
TSPL.docc/LanguageGuide/Concurrency.md
40+
TSPL.docc/LanguageGuide/Macros.md
41+
TSPL.docc/LanguageGuide/TypeCasting.md
42+
TSPL.docc/LanguageGuide/NestedTypes.md
43+
TSPL.docc/LanguageGuide/Extensions.md
44+
TSPL.docc/LanguageGuide/Protocols.md
45+
TSPL.docc/LanguageGuide/Generics.md
46+
TSPL.docc/LanguageGuide/OpaqueTypes.md
47+
TSPL.docc/LanguageGuide/AutomaticReferenceCounting.md
48+
TSPL.docc/LanguageGuide/MemorySafety.md
49+
TSPL.docc/LanguageGuide/AccessControl.md
50+
TSPL.docc/LanguageGuide/AdvancedOperators.md
51+
52+
TSPL.docc/ReferenceManual/AboutTheLanguageReference.md
53+
TSPL.docc/ReferenceManual/LexicalStructure.md
54+
TSPL.docc/ReferenceManual/Types.md
55+
TSPL.docc/ReferenceManual/Expressions.md
56+
TSPL.docc/ReferenceManual/Statements.md
57+
TSPL.docc/ReferenceManual/Declarations.md
58+
TSPL.docc/ReferenceManual/Attributes.md
59+
TSPL.docc/ReferenceManual/Patterns.md
60+
TSPL.docc/ReferenceManual/GenericParametersAndArguments.md
61+
TSPL.docc/ReferenceManual/SummaryOfTheGrammar.md
62+
63+
TSPL.docc/RevisionHistory/RevisionHistory.md
64+
65+
# Files that don't match a pattern listed above appear at the end.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,4 @@
22
Replace this paragraph with your rationale and a brief summary of what changed.
33

44
<!-- If this pull request fixes a bug tracked in GitHub issues, provide the link. -->
5-
Fixes https://github.com/apple/swift-book/issues/####
6-
7-
8-
<!--
9-
Before merging this pull request, you must run the continuous integration (CI) tests.
10-
When you're ready to start a CI build,
11-
write the following in a comment on the pull request:
12-
13-
@swift-ci Please test.
14-
15-
For more information about triggering CI builds via @swift-ci, see:
16-
17-
https://github.com/apple/swift/blob/main/docs/ContinuousIntegration.md#swift-ci
18-
19-
Thank you for your contribution!
20-
-->
5+
Fixes: https://github.com/apple/swift-book/issues/####

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,15 @@ in this repository's root directory.
4242

4343
After running DocC, open the link that `docc` outputs
4444
to display a local preview in your browser.
45+
46+
> Note:
47+
>
48+
> If you installed DocC by downloading a toolchain from Swift.org,
49+
> `docc` is located in `usr/bin/`,
50+
> relative to the installation path of the toolchain.
51+
> Make sure your shell's `PATH` environment variable
52+
> includes that directory.
53+
>
54+
> If you installed DocC by downloading Xcode,
55+
> run `xcrun docc preview TSPL.docc` instead.
56+

Style.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,11 @@ which means it’s not always suitable for generating a parser for Swift code.
9898

9999
# Terms and Rules
100100

101+
## attribute names
102+
103+
In the guide, write `@` before attribute names;
104+
in the reference, omit it.
105+
101106
## back deploy
102107

103108
Spelled as two words, not closed up or hyphenated.
@@ -122,6 +127,13 @@ you should generally try to avoid them.
122127
Deeply nested headings often indicate
123128
that there’s a better way to organize the content.
124129

130+
## macro names
131+
132+
In the guide,
133+
write `@` before the name when referring to attached macros
134+
and `#` before the name when referring to freestanding macros.
135+
In the reference, omit it.
136+
125137
## memberwise initializer
126138

127139
Not hyphenated as “member-wise”.
20.6 KB
Loading
20.4 KB
Loading
37.6 KB
Loading
37.4 KB
Loading
6.12 KB
Loading

0 commit comments

Comments
 (0)