[swift-evolution] [swift-evolution-announce] [Review] SE-0023 API Design Guidelines
erica at ericasadun.com
Fri Jan 29 10:11:45 CST 2016
> Overall, I like the proposal. It provides sound guidance that can lead to consistent code in practice. However, there are some issues and concerns I have:
> - Under "Fundamentals", there is a bullet called "Write a documentation comment...". Under this bullet, this is another bullet called "Use a single sentence fragment...". Why? I find sentence fragments often detract from clarity and concise nature, which can lead to confusion.
This fragment is added to the name of the function so if you have a function named "myFunction", the descriptive fragment is "converts integers to strings." and the display is:
Description: myFunction converts integers to string.
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the swift-evolution