New User's Comments Feature on the Google SketchUp Ruby API documentation site
Google Code is running a pilot on user-contributed notes to the API documentation. This feature is currently enabled for the documentation of a handful of products, including the Google SketchUp Ruby API! The ultimate goal of this feature is to provide a richer documentation experience for our developers, similar to that offered in open source projects such as php.net.
We invite you to participate by adding notes, insights, or code examples to a particular doc. Your note may take up to 24 hours to appear after you submit it. All notes will be moderated to ensure they provide a useful contribution to the topic to which they are attached. Requests for help with the API should not be submitted as notes, but should continue to be posted to the Google SketchUp Developers Google Group.
Posted by Simone Nicolo, Google Sketchup Team
Google Code is running a pilot on user-contributed notes to the API documentation. This feature is currently enabled for the documentation of a handful of products, including the Google SketchUp Ruby API! The ultimate goal of this feature is to provide a richer documentation experience for our developers, similar to that offered in open source projects such as php.net.
We invite you to participate by adding notes, insights, or code examples to a particular doc. Your note may take up to 24 hours to appear after you submit it. All notes will be moderated to ensure they provide a useful contribution to the topic to which they are attached. Requests for help with the API should not be submitted as notes, but should continue to be posted to the Google SketchUp Developers Google Group.
Posted by Simone Nicolo, Google Sketchup Team
3 comments:
I just added a comment to the API entry for tool. The formatting gets lost, making any code snippets you add pretty much unreadable.
The comment section would greatly benefit from basic formatting such as italic and bold. Most importantly code blocks. You see this enabled in the php.net docs which was referenced.
Support for some HTML markup should be coming soon.
Post a Comment