{"id":565,"date":"2006-02-02T13:25:40","date_gmt":"2006-02-02T03:25:40","guid":{"rendered":"http:\/\/www.flamingspork.com\/blog\/2006\/02\/02\/comments-on-online-documentation\/"},"modified":"2006-02-02T13:25:40","modified_gmt":"2006-02-02T03:25:40","slug":"comments-on-online-documentation","status":"publish","type":"post","link":"https:\/\/www.flamingspork.com\/blog\/2006\/02\/02\/comments-on-online-documentation\/","title":{"rendered":"comments on online documentation"},"content":{"rendered":"

Something that makes me always just go to dev.mysql.com<\/a> or php.net<\/a> for documentation is the user comments. sometimes you just find some real jems that are really worth reading.<\/p>\n

It would be great if this somehow could get integrated into the (offline) help system in GNOME<\/a> could somehow have this stuff integrated. maybe some AJAX foo to fetch comments from the Interweb if you’re connected. So then you get the best of three worlds: good graphical documentation interface, good documentation and user comments to the docs!<\/p>\n","protected":false},"excerpt":{"rendered":"

Something that makes me always just go to dev.mysql.com or php.net for documentation is the user comments. sometimes you just find some real jems that are really worth reading. It would be great if this somehow could get integrated into … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[10,14],"tags":[],"class_list":["post-565","post","type-post","status-publish","format-standard","hentry","category-gnome","category-mysql"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p5a6n8-97","jetpack-related-posts":[{"id":449,"url":"https:\/\/www.flamingspork.com\/blog\/2005\/08\/08\/comments-are-evil\/","url_meta":{"origin":565,"position":0},"title":"Comments Are Evil","author":"Stewart Smith","date":"2005-08-08","format":false,"excerpt":"When a comment above a function says \"returns -1 on error\" and the code does the exact oposite (returns -1 anyway except if there was out of memory error, which may be #defined to -1 anyway) it's a bit annoying when you first look at it. Remember kids, comments in\u2026","rel":"","context":"In "life, the universe and everything"","block_context":{"text":"life, the universe and everything","link":"https:\/\/www.flamingspork.com\/blog\/category\/life-the-universe-and-everything\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":238,"url":"https:\/\/www.flamingspork.com\/blog\/2004\/06\/07\/exciting-new-world-of-comments\/","url_meta":{"origin":565,"position":1},"title":"exciting new world of comments","author":"Stewart Smith","date":"2004-06-07","format":false,"excerpt":"comments are back! well, until the spam is unmanagable, and then i'll have to go and moderate everything. At least it's better than MT though, where it just accepts everything and you have to go hunting for bad things. I like WordPress! I've started to use Straw again, a cool\u2026","rel":"","context":"In "General"","block_context":{"text":"General","link":"https:\/\/www.flamingspork.com\/blog\/category\/general\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":2409,"url":"https:\/\/www.flamingspork.com\/blog\/2011\/10\/05\/using-jenkins-to-parse-sphinx-warnings\/","url_meta":{"origin":565,"position":2},"title":"Using Jenkins to parse sphinx warnings","author":"Stewart Smith","date":"2011-10-05","format":false,"excerpt":"At Percona, we're now using sphinx for our documentation. We're also using Jenkins for our \u00c2\u00a0continuous integration. We have compiler warnings from GCC being parsed by Jenkins using the built in filters, but there isn't one for the sphinx warnings. Luckily, in the configuration page for Jenkins, the Warnings plugin\u2026","rel":"","context":"In "code"","block_context":{"text":"code","link":"https:\/\/www.flamingspork.com\/blog\/category\/code\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/www.flamingspork.com\/blog\/wp-content\/uploads\/2011\/10\/jenkins-sphinx.png?resize=350%2C200","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/www.flamingspork.com\/blog\/wp-content\/uploads\/2011\/10\/jenkins-sphinx.png?resize=350%2C200 1x, https:\/\/i0.wp.com\/www.flamingspork.com\/blog\/wp-content\/uploads\/2011\/10\/jenkins-sphinx.png?resize=525%2C300 1.5x, https:\/\/i0.wp.com\/www.flamingspork.com\/blog\/wp-content\/uploads\/2011\/10\/jenkins-sphinx.png?resize=700%2C400 2x"},"classes":[]},{"id":2186,"url":"https:\/\/www.flamingspork.com\/blog\/2010\/11\/01\/improved-haildb-documentation\/","url_meta":{"origin":565,"position":3},"title":"Improved HailDB documentation","author":"Stewart Smith","date":"2010-11-01","format":false,"excerpt":"I just spent some time on the Doxygen documentation for HailDB, making sure all the new APIs are documented. You can view them online over at http:\/\/www.haildb.com\/doc\/api\/html\/","rel":"","context":"In "code"","block_context":{"text":"code","link":"https:\/\/www.flamingspork.com\/blog\/category\/code\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":3972,"url":"https:\/\/www.flamingspork.com\/blog\/2015\/06\/16\/opal-firmware-specification-conformance-and-documentation\/","url_meta":{"origin":565,"position":4},"title":"OPAL firmware specification, conformance and documentation","author":"Stewart Smith","date":"2015-06-16","format":false,"excerpt":"Now that we have an increasing amount of things that run on top of OPAL: Linux hello_world (in skiboot tree) ppc64le_hello (as I wrote about yesterday) FreeBSD and that the OpenPower ecosystem is rapidly growing (especially around people building OpenPower machines), the need for more formal specification, conformance testing and\u2026","rel":"","context":"In "code"","block_context":{"text":"code","link":"https:\/\/www.flamingspork.com\/blog\/category\/code\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":4850,"url":"https:\/\/www.flamingspork.com\/blog\/2023\/06\/25\/getting-your-photos-out-of-shotwell\/","url_meta":{"origin":565,"position":5},"title":"Getting your photos out of Shotwell","author":"Stewart Smith","date":"2023-06-25","format":false,"excerpt":"Somewhat a while ago now, I wrote about how every time I return to write some software for the Mac, the preferred language has changed. The purpose of this adventure was to get my photos out of the aging Shotwell and onto my (then new) Mac and the Apple Photos\u2026","rel":"","context":"In "General"","block_context":{"text":"General","link":"https:\/\/www.flamingspork.com\/blog\/category\/general\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/www.flamingspork.com\/blog\/wp-content\/uploads\/2023\/06\/image.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/www.flamingspork.com\/blog\/wp-content\/uploads\/2023\/06\/image.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/www.flamingspork.com\/blog\/wp-content\/uploads\/2023\/06\/image.png?resize=525%2C300&ssl=1 1.5x, https:\/\/i0.wp.com\/www.flamingspork.com\/blog\/wp-content\/uploads\/2023\/06\/image.png?resize=700%2C400&ssl=1 2x"},"classes":[]}],"jetpack_likes_enabled":true,"_links":{"self":[{"href":"https:\/\/www.flamingspork.com\/blog\/wp-json\/wp\/v2\/posts\/565","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.flamingspork.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.flamingspork.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.flamingspork.com\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.flamingspork.com\/blog\/wp-json\/wp\/v2\/comments?post=565"}],"version-history":[{"count":0,"href":"https:\/\/www.flamingspork.com\/blog\/wp-json\/wp\/v2\/posts\/565\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.flamingspork.com\/blog\/wp-json\/wp\/v2\/media?parent=565"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.flamingspork.com\/blog\/wp-json\/wp\/v2\/categories?post=565"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.flamingspork.com\/blog\/wp-json\/wp\/v2\/tags?post=565"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}