[swift-evolution] [Review] SE-0006 Apply API Guidelines to the Standard Library
dabrahams at apple.com
Fri Feb 5 15:35:41 CST 2016
on Fri Feb 05 2016, Ben Rimmington <swift-evolution at swift.org> wrote:
> Proposal link:
>> precondition was renamed to require.
> In the Standard Library, "- Requires:" appears in documentation
> comments more often than "- Precondition:" or "- Postcondition:", so
> renaming the function makes sense.
> However, I think the Xcode Markup Formatting Reference should be
> updated to reflect this usage. The current description is:
>> Use the field to add requirements such as frameworks for using the symbol.
>> An example of using the requires field
>> - requires: Contacts framework
>> - requires: OS X version 10.11 or better
And what do you think it *should* say?
More information about the swift-evolution