[swift-evolution] API Guidelines Update

Dave Abrahams dabrahams at apple.com
Thu Feb 18 18:07:35 CST 2016


Thanks, Charles!  Could I entice you to submit a pull request against
https://github.com/apple/swift-internals/blob/gh-pages/api-design-guidelines/index.md
with these changes?

(You can do this entirely on GitHub by clicking on the pencil at the top).

on Thu Feb 18 2016, Charles Kissinger <crk-AT-akkyra.com> wrote:

> Three places where you might have intended different wording:
>
> "Prefer names of function and other methods that make use sites form grammatical English phrases.”
> Should it be:
> "Prefer method and function names that make use sites form grammatical English phrases.” ?
>
> “Initializer and factory methods calls should form a phrase that does not include the first argument, e.g.”
>  Should it be:
> “Initializer and factory method calls should form a phrase that does not include the first argument, e.g.” ?
>
> “Label closure parameters and the tuple members where they appear in your API.”
> Should it be:
> “Label closure parameters and tuple members where they appear in your API.” ?
>
> Also, there appears to be a repeated “the” here:
> /// **`byteCount`** equal to the the number of maximally-aligned
>
> —CK
>
>> On Feb 16, 2016, at 6:31 PM, Dave Abrahams via swift-evolution <swift-evolution at swift.org> wrote:
>> 
>> 
>> I've updated the API guidelines document to account for the review
>> feedback and other issues.  Please see
>> http://apple.github.io/swift-internals/api-design-guidelines/
>> (presentation view)
>> and
>> https://github.com/apple/swift-internals/blob/gh-pages/api-design-guidelines/index.md
>> (source and commit history)
>> 
>> -- 
>> -Dave
>> 
>> _______________________________________________
>> swift-evolution mailing list
>> swift-evolution at swift.org
>> https://lists.swift.org/mailman/listinfo/swift-evolution

-- 
-Dave


More information about the swift-evolution mailing list