Yet Another Design Book?
From APIDesign
(Difference between revisions)
| Line 8: | Line 8: | ||
* I'd love to have one extra historical tidbit in the introduction somewhere: what's the origin of the term API? I first remember hearing it in the early 90's, but it's possibly older than that. I spent some time searching using Google, but came up empty-handed. Can you research this? | * I'd love to have one extra historical tidbit in the introduction somewhere: what's the origin of the term API? I first remember hearing it in the early 90's, but it's possibly older than that. I spent some time searching using Google, but came up empty-handed. Can you research this? | ||
* (spelling) I'd prefer seeing a hyphen in the term "object-oriented" throughout the text. | * (spelling) I'd prefer seeing a hyphen in the term "object-oriented" throughout the text. | ||
| + | ** Wikipedia is silent on explaining the origin, and I know nothing about it either, so I think I need to skip this | ||
* (spelling) paragraph 3: "decade old" => "decade-old" | * (spelling) paragraph 3: "decade old" => "decade-old" | ||
--[[User:AdamDingle|AdamDingle]] | --[[User:AdamDingle|AdamDingle]] | ||
| + | |||
| + | |||
* Third paragraph makes claims about backwards compatibility, which I mostly agree with. However, I got started with platform development just after 4.0 was released and tried to follow examples from the NetBeans Definitive Guide. I remember vividly that I could not get anything to work because of the NoClassDefFound errors on TopManager, so I would recommend making those claims a little less strong in case others remember as well. | * Third paragraph makes claims about backwards compatibility, which I mostly agree with. However, I got started with platform development just after 4.0 was released and tried to follow examples from the NetBeans Definitive Guide. I remember vividly that I could not get anything to work because of the NoClassDefFound errors on TopManager, so I would recommend making those claims a little less strong in case others remember as well. | ||
| + | ** Fixed in '''ef6194effbfc''', although the first sentence says that only 'some' not all | ||
--[[User:TomWheeler|TomWheeler]] | --[[User:TomWheeler|TomWheeler]] | ||
* Grammar: last paragraph, your tenses are mixed. I would suggest: "Since then, I've known the need for information relating to API design is real. The memory of that presentation has encouraged me whenever I've begun to lose motivation while writing this book. It has helped to remind me that the rules for proper API design that we've discovered need to be documented. | * Grammar: last paragraph, your tenses are mixed. I would suggest: "Since then, I've known the need for information relating to API design is real. The memory of that presentation has encouraged me whenever I've begun to lose motivation while writing this book. It has helped to remind me that the rules for proper API design that we've discovered need to be documented. | ||
--[[User:RichUnger|RichUnger]] | --[[User:RichUnger|RichUnger]] | ||
Revision as of 08:29, 1 April 2008
- Is there a space before [GoF]?
- Notice [book.effective] towards end of paragpraph
- Grammar: Page 1, 3rd paragraph, change to "Despite that, the API clients that compiled their code then are still able to execute their code TODAY, even with the latest versions of those libraries."
- Punctuation: Page 1, Paragraph 4 - should use dash instead of comma between "the code, that is"
- Spelling: Page 1, Para 4 - "Overtime" should be "Over time" ("Overtime" is what you get paid when you work too many hours)
--Dmkoelle 20:12, 26 March 2008 (UTC)
- I'd love to have one extra historical tidbit in the introduction somewhere: what's the origin of the term API? I first remember hearing it in the early 90's, but it's possibly older than that. I spent some time searching using Google, but came up empty-handed. Can you research this?
- (spelling) I'd prefer seeing a hyphen in the term "object-oriented" throughout the text.
- Wikipedia is silent on explaining the origin, and I know nothing about it either, so I think I need to skip this
- (spelling) paragraph 3: "decade old" => "decade-old"
- Third paragraph makes claims about backwards compatibility, which I mostly agree with. However, I got started with platform development just after 4.0 was released and tried to follow examples from the NetBeans Definitive Guide. I remember vividly that I could not get anything to work because of the NoClassDefFound errors on TopManager, so I would recommend making those claims a little less strong in case others remember as well.
- Fixed in ef6194effbfc, although the first sentence says that only 'some' not all
- Grammar: last paragraph, your tenses are mixed. I would suggest: "Since then, I've known the need for information relating to API design is real. The memory of that presentation has encouraged me whenever I've begun to lose motivation while writing this book. It has helped to remind me that the rules for proper API design that we've discovered need to be documented.
Follow
