[swift-evolution] [Review] SE-0023 API Design Guidelines

[Joseph Lord]

Overall I like the proposals but I do have comments on a few issues.

enum case capitalisation. I generally like the use of lowerCamelCase 
names because they are not types. Types are determined at compile time 
and the case (value) of an enum is only known at runtime. I have already 
seen people get confused by expecting to be able to use information 
about an enum value at compile time. I think normally using 
upperCamelCase would increase the confusion between cases and types.


I have flicked through the thread and there are some good interesting 
discussions particularly about argument labels in different ways. I'm 
not sure there are any specific changes I want to strongly back but the 
current proposals are not the uniquely correct approach. If there are 
substantial changes it would be good to run them through as a proposal 
for changes on top of this one so that they get proper review, the 
thread is huge and many people may have missed things that they really 
care about.

Joseph

On 22/01/2016 21:02, Douglas Gregor via swift-evolution wrote:
> Hello Swift community,
>
> The review of SE-0023"API Design Guidelines" begins now and runs through
> January 31, 2016. The proposal is available here:
>
>     https://github.com/apple/swift-evolution/blob/master/proposals/0023-api-guidelines.md
>
> Reviews are an important part of the Swift evolution process. All
> reviews should be sent to the swift-evolution mailing list at
>
>     https://lists.swift.org/mailman/listinfo/swift-evolution
>
> or, if you would like to keep your feedback private, directly to the
> review manager. When replying, please try to keep the proposal link at
> the top of the message:
>
>     Proposal link:
>
>         https://github.com/apple/swift-evolution/blob/master/proposals/0023-api-guidelines.md
>
>     Reply text
>
>         Other replies
>
>
>           <https://github.com/apple/swift-evolution#what-goes-into-a-review-1>What
>           goes into a review?
>
> The goal of the review process is to improve the proposal under review
> through constructive criticism and, eventually, determine the direction
> of Swift. When writing your review, here are some questions you might
> want to answer in your review:
>
>   * What is your evaluation of the proposal?
>   * Is the problem being addressed significant enough to warrant a
>     change to Swift?
>   * Does this proposal fit well with the feel and direction of Swift?
>   * If you have used other languages or libraries with a similar
>     feature, how do you feel that this proposal compares to those?
>   * How much effort did you put into your review? A glance, a quick
>     reading, or an in-depth study?
>
> More information about the Swift evolution process is available at
>
>     https://github.com/apple/swift-evolution/blob/master/process.md
>
> Thank you,
>
> -Doug Gregor
>
> Review Manager
>
>
>
> _______________________________________________
> swift-evolution mailing list
> swift-evolution at swift.org
> https://lists.swift.org/mailman/listinfo/swift-evolution
>


-- 
Human Friendly Ltd.