Skip to content

Commit 4616756

Browse files
committed
Merge pull request #113 from dabrahams/master
Add reviewer notes for the upcoming review
2 parents 737ed65 + 20dd703 commit 4616756

File tree

3 files changed

+66
-0
lines changed

3 files changed

+66
-0
lines changed

proposals/0005-objective-c-name-translation.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,28 @@
44
* Author(s): [Doug Gregor](https://github.com/DougGregor), [Dave Abrahams](https://github.com/dabrahams)
55
* Status: **Awaiting review** (January 21...31, 2016)
66

7+
## Reviewer notes
8+
9+
This review is part of a group of three related reviews, running
10+
concurrently:
11+
12+
* [SE-0023 API Design Guidelines](https://github.com/apple/swift-evolution/blob/master/proposals/0023-api-guidelines.md)
13+
* [SE-0006 Apply API Guidelines to the Standard Library](https://github.com/apple/swift-evolution/blob/master/proposals/0006-apply-api-guidelines-to-the-standard-library.md)
14+
* [SE-0005 Better Translation of Objective-C APIs Into Swift](https://github.com/apple/swift-evolution/blob/master/proposals/0005-objective-c-name-translation.md)
15+
16+
These reviews are running concurrently because they interact strongly
17+
(e.g., an API change in the standard library will correspond to a
18+
particular guideline, or an importer rule implements a particular
19+
guideline, etc.). Because of these interactions, and to keep
20+
discussion manageable, we ask that you:
21+
22+
* **Please get a basic understanding of all three documents** before
23+
posting review commentary
24+
* **Please post your review of each individual document in response to
25+
its review announcement**. It's okay (and encouraged) to make
26+
cross-references between the documents in your review where it helps
27+
you make a point.
28+
729
## Introduction
830

931
This proposal describes how we can improve Swift's "Clang Importer", which is responsible for mapping C and Objective-C APIs into Swift, to translate the names of Objective-C functions, types, methods, properties, etc. into names that more closely align with the [Swift API Design Guidelines][api-design-guidelines] being developed as part of Swift 3. Our approach focuses on the differences between the Objective-C [Coding Guidelines for Cocoa][objc-cocoa-guidelines] and the Swift API Design Guidelines, using some simple linguistic analysis to aid the automatic translation from Objective-C names to more "Swifty" names.

proposals/0006-apply-api-guidelines-to-the-standard-library.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,28 @@
55
* Status: **Awaiting Review** (January 21...31, 2016)
66
* Review manager: [Doug Gregor](https://github.com/DougGregor)
77

8+
## Reviewer notes
9+
10+
This review is part of a group of three related reviews, running
11+
concurrently:
12+
13+
* [SE-0023 API Design Guidelines](https://github.com/apple/swift-evolution/blob/master/proposals/0023-api-guidelines.md)
14+
* [SE-0006 Apply API Guidelines to the Standard Library](https://github.com/apple/swift-evolution/blob/master/proposals/0006-apply-api-guidelines-to-the-standard-library.md)
15+
* [SE-0005 Better Translation of Objective-C APIs Into Swift](https://github.com/apple/swift-evolution/blob/master/proposals/0005-objective-c-name-translation.md)
16+
17+
These reviews are running concurrently because they interact strongly
18+
(e.g., an API change in the standard library will correspond to a
19+
particular guideline, or an importer rule implements a particular
20+
guideline, etc.). Because of these interactions, and to keep
21+
discussion manageable, we ask that you:
22+
23+
* **Please get a basic understanding of all three documents** before
24+
posting review commentary
25+
* **Please post your review of each individual document in response to
26+
its review announcement**. It's okay (and encouraged) to make
27+
cross-references between the documents in your review where it helps
28+
you make a point.
29+
830
## Introduction
931

1032
[Swift API Design Guidelines][api-design-guidelines] being developed as

proposals/0023-api-guidelines.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,28 @@
44
* Author(s): Dave Abrahams, Doug Gregor, Dmitri Hrybenko, Ted Kremenek, Chris Lattner, Alex Migicovsky, Max Moiseev, Ali Ozer, Tony Parker
55
* Status: **Awaiting review** (January 21...31, 2016)
66

7+
## Reviewer notes
8+
9+
This review is part of a group of three related reviews, running
10+
concurrently:
11+
12+
* [SE-0023 API Design Guidelines](https://github.com/apple/swift-evolution/blob/master/proposals/0023-api-guidelines.md)
13+
* [SE-0006 Apply API Guidelines to the Standard Library](https://github.com/apple/swift-evolution/blob/master/proposals/0006-apply-api-guidelines-to-the-standard-library.md)
14+
* [SE-0005 Better Translation of Objective-C APIs Into Swift](https://github.com/apple/swift-evolution/blob/master/proposals/0005-objective-c-name-translation.md)
15+
16+
These reviews are running concurrently because they interact strongly
17+
(e.g., an API change in the standard library will correspond to a
18+
particular guideline, or an importer rule implements a particular
19+
guideline, etc.). Because of these interactions, and to keep
20+
discussion manageable, we ask that you:
21+
22+
* **Please get a basic understanding of all three documents** before
23+
posting review commentary
24+
* **Please post your review of each individual document in response to
25+
its review announcement**. It's okay (and encouraged) to make
26+
cross-references between the documents in your review where it helps
27+
you make a point.
28+
729
## Introduction
830

931
The design of commonly-used libraries has a large impact on the

0 commit comments

Comments
 (0)