[Extending review] SE-0005, SE-0006, SE-0023 API Guidelines and impact


(Douglas Gregor) #1

Hello Swift community,

Due to ongoing discussion of the API guidelines and related proposals, as well as the large-scale impact these changes will have on Swift, we’re extending the review of SE-0005, SE-0006, and SE-0023 through next Friday, February 5th. You can read more about the “Great Swift API Transformation” these proposals introduce, see:

  https://swift.org/blog/swift-api-transformation/

  Thank you,
  Doug Gregor
  Review Manager


(Daniel Steinberg) #2

Doug,

There has been a lot of wisdom and good advice that has been part of the swift-evolution list that could be included in the API Guidelines. This could help developers determine (using a recent list discussion), when to prefer a computed property over a function that takes no parameters and returns a value. When to prefer a struct over a class … , when should we create a mutating method and when is it best not to,

Because these higher level considerations have no impact on Swift 3, they can wait - but at some point I’d love to see the document expanded to include these decisions that programmers make all the time where we would love to see some collection of best practices that new-comers to the language can adopt and emulate.

Best,

Daniel

···

On Jan 30, 2016, at 3:18 PM, Douglas Gregor via swift-evolution <swift-evolution@swift.org> wrote:

Hello Swift community,

Due to ongoing discussion of the API guidelines and related proposals, as well as the large-scale impact these changes will have on Swift, we’re extending the review of SE-0005, SE-0006, and SE-0023 through next Friday, February 5th. You can read more about the “Great Swift API Transformation” these proposals introduce, see:

  https://swift.org/blog/swift-api-transformation/

  Thank you,
  Doug Gregor
  Review Manager

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution


(Douglas Gregor) #3

Doug,

There has been a lot of wisdom and good advice that has been part of the swift-evolution list that could be included in the API Guidelines. This could help developers determine (using a recent list discussion), when to prefer a computed property over a function that takes no parameters and returns a value. When to prefer a struct over a class … , when should we create a mutating method and when is it best not to,

Because these higher level considerations have no impact on Swift 3, they can wait - but at some point I’d love to see the document expanded to include these decisions that programmers make all the time where we would love to see some collection of best practices that new-comers to the language can adopt and emulate.

I do hope that the API guidelines will continue to evolve over time. We’ve focused most on naming because that’s it's fundamental and has such a significant impact, but I agree that many of these other areas could benefit from guidelines. For some (e.g., struct or class?), I expect we’ll need more time for the community to establish best practices before we can codify them.

  - Doug

···

On Feb 1, 2016, at 5:54 AM, Daniel Steinberg <daniel@dimsumthinking.com> wrote:

Best,

Daniel

On Jan 30, 2016, at 3:18 PM, Douglas Gregor via swift-evolution <swift-evolution@swift.org> wrote:

Hello Swift community,

Due to ongoing discussion of the API guidelines and related proposals, as well as the large-scale impact these changes will have on Swift, we’re extending the review of SE-0005, SE-0006, and SE-0023 through next Friday, February 5th. You can read more about the “Great Swift API Transformation” these proposals introduce, see:

  https://swift.org/blog/swift-api-transformation/

  Thank you,
  Doug Gregor
  Review Manager

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution