LuckyDonkey » Objective C http://www.luckydonkey.com Never knowingly knowing narwhals Wed, 17 Mar 2010 01:05:54 +0000 en hourly 1 http://wordpress.org/?v=3.0 Humorous Examples in documentation http://www.luckydonkey.com/2007/03/23/humorous-examples-in-documentation/ http://www.luckydonkey.com/2007/03/23/humorous-examples-in-documentation/#comments Fri, 23 Mar 2007 15:06:18 +0000 dazza http://www.luckydonkey.com/2007/03/23/humorous-examples-in-documentation/ I've been a fan of adding a little humor to dry documentation for as long as I've been reading dry documentation. It doesn't need to be a stand up routine Just a little bit of the character of the author will do. I just came across this in the Cocoa documentation for NSString:

Discussion
The substrings in the array appear in the order they did in the receiver. If the string begins or ends with the separator, the first or last substring, respectively, is empty. For example, this code fragment:

NSString *list = @"Norman, Stanley, Fletcher";
NSArray *listItems = [list componentsSeparatedByString:@", "];
produces an array { @"Norman", @"Stanley", @"Fletcher" }.

For those who didn't grow up in the eighties Norman Stanley Fletcher is a famous rogue from british television. Made me laugh for a moment :lol: Back to grindstone.

]]> http://www.luckydonkey.com/2007/03/23/humorous-examples-in-documentation/feed/ 0