{"id":586,"date":"2019-05-12T20:24:32","date_gmt":"2019-05-13T00:24:32","guid":{"rendered":"https:\/\/2019.hamilton.wordcamp.org\/?post_type=wcb_session&#038;p=586"},"modified":"2019-07-31T19:35:16","modified_gmt":"2019-07-31T23:35:16","slug":"not-just-witty-comments-in-your-code-documentation-best-practices-for-themes-plugins-and-apis","status":"publish","type":"wcb_session","link":"https:\/\/hamilton.wordcamp.org\/2019\/session\/not-just-witty-comments-in-your-code-documentation-best-practices-for-themes-plugins-and-apis\/","title":{"rendered":"Not just witty comments in your code: Documentation best practices for themes, plugins and APIs"},"content":{"rendered":"\n<p>As a developer in the WordPress ecosystem, you\u2019re part of a large open source community; and being part of a community, being a good neighbour goes a long way. You\u2019re thinking of or already developing components for WordPress, but developing is just the beginning: allowing your code to be used or modified easily will get you more goodwill within the community. That means documentation; meaning useful code comments, user manuals and API docs.<\/p>\n\n\n\n<p>We\u2019ll discuss documentation standards, best practices, and how to make your users and other developers sing your praises.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>As a developer in the WordPress ecosystem, you\u2019re part of a large open source community; and being part of a community, being a good neighbour goes a long way. You\u2019re thinking of or already developing components for WordPress, but developing is just the beginning: allowing your code to be used or modified easily will get &hellip; <\/p>\n<p class=\"link-more\"><a href=\"https:\/\/hamilton.wordcamp.org\/2019\/session\/not-just-witty-comments-in-your-code-documentation-best-practices-for-themes-plugins-and-apis\/\" class=\"more-link\">Continue reading<span class=\"screen-reader-text\"> &#8220;Not just witty comments in your code: Documentation best practices for themes, plugins and APIs&#8221;<\/span><\/a><\/p>\n","protected":false},"author":7650547,"featured_media":0,"template":"","meta":{"jetpack_post_was_ever_published":false,"_wcpt_session_time":1559421000,"_wcpt_session_duration":3000,"_wcpt_session_type":"session","_wcpt_session_slides":"https:\/\/t.co\/qpsIcAKw11","_wcpt_session_video":"","_wcpt_speaker_id":[252],"footnotes":""},"session_track":[13412],"session_category":[],"class_list":["post-586","wcb_session","type-wcb_session","status-publish","hentry","wcb_track-track-2","entry"],"jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/paqJhZ-9s","session_date_time":{"date":"June 1, 2019","time":"4:30 pm"},"session_speakers":[{"id":"252","slug":"matt-graham","name":"Matt Graham","link":"https:\/\/hamilton.wordcamp.org\/2019\/speaker\/matt-graham\/"}],"session_cats_rendered":null,"_links":{"self":[{"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wp\/v2\/sessions\/586","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wp\/v2\/sessions"}],"about":[{"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wp\/v2\/types\/wcb_session"}],"version-history":[{"count":1,"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wp\/v2\/sessions\/586\/revisions"}],"predecessor-version":[{"id":587,"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wp\/v2\/sessions\/586\/revisions\/587"}],"speakers":[{"embeddable":true,"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wp\/v2\/speakers\/252"}],"author":[{"embeddable":true,"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wporg\/v1\/users\/themattyg"}],"wp:attachment":[{"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wp\/v2\/media?parent=586"}],"wp:term":[{"taxonomy":"wcb_track","embeddable":true,"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wp\/v2\/session_track?post=586"},{"taxonomy":"wcb_session_category","embeddable":true,"href":"https:\/\/hamilton.wordcamp.org\/2019\/wp-json\/wp\/v2\/session_category?post=586"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}