Swift 3.0 API Guidelines Pass 1

[mliberatore]

Begins work on API renaming as part of #123

📝 This is pointing at the new swift-3.0 branch, not develop.

These are all manual edits made to API names (and a bit of refactoring where appropriate). That is to say, none of this work was performed by the migrator. Migration occurred in #127.

Related:

• https://developer.apple.com/videos/play/wwdc2016/403/
• https://swift.org/documentation/api-design-guidelines/

[mbbischoff]

We can remove the word font from these methods, no?

[mliberatore]

Which font do you propose removing? The one from sourceSansProFont or fontSize?

I was deliberately keeping these in line with ’s:

public class func systemFont(ofSize fontSize: CGFloat) -> UIFont

But I see how you could make an argument similar to UIColor.whateverColor() → UIColor.whatever().

[mbbischoff]

But I see how you could make an argument similar to UIColor.whateverColor() → UIColor.whatever().

This is exactly how I’m thinking of it. I think we can safely remove both, but if we want to be a bit more conservative just the first one.

[mliberatore]

So just to be clear, you’re thinking:

public static func sourceSansPro(ofSize: size CGFloat, weight: FontWeight = .regular) -> UIFont
public static func menloRegular(ofSize size: CGFloat) -> UIFont

With call sites looking like:

UIFont.sourceSansPro(ofSize: 32.0)
UIFont.menloRegular(ofSize: 16.0)

I’d be happy to make the change but am worried we’re deviating from the naming changes in UIFont. UIFont APIs were renamed, from e.g.:

public class func systemFontOfSize(fontSize: CGFloat, weight: CGFloat) -> UIFont

to:

public class func systemFont(ofSize fontSize: CGFloat, weight: CGFloat) -> UIFont

with no dropping of "font".

At this stage, would a radar be more appropriate (perhaps we can call out specifics in the API guidelines to warrant these APIs changing), or do you think it’s not worth keeping directly in sync with similar signatures in UIKit?

[mbbischoff]

Yeah, I guess you’re right. There is one difference UIFont.system wouldn’t make a lot of intuitive sense because system doesn’t really sound like a specific font, whereas UIFont.futura definitely reads like UIColor.red. I think a radar for now and leaving it as is a good approach. Let me know if you want me to file it.

[mliberatore]

I’m happy to take care of it.

[mliberatore]

And good point about system. I go back and forth on UIFont.system, personally. In context, I think it would seem reasonable on its own: label.font = .system, but with a parameter, not so much: label.font = .system(ofSize: 32).

[mliberatore]

Filed rdar://27250975.