{"id":660,"date":"2009-11-25T15:24:09","date_gmt":"2009-11-25T23:24:09","guid":{"rendered":"https:\/\/mathpirate.net\/log\/?p=660"},"modified":"2009-11-25T15:24:09","modified_gmt":"2009-11-25T23:24:09","slug":"rule-1-the-documentation-must-not-suck","status":"publish","type":"post","link":"https:\/\/mathpirate.net\/log\/2009\/11\/25\/rule-1-the-documentation-must-not-suck\/","title":{"rendered":"Rule #1: The Documentation Must Not Suck"},"content":{"rendered":"<p>So that&#8217;s how you create, initialize, and\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0 a SpeechRecognizer&#8230;<\/p>\n<p><a href=\"https:\/\/mathpirate.net\/log\/wp-content\/uploads\/2009\/11\/WonderfulExamples.png\"><img decoding=\"async\" loading=\"lazy\" class=\"alignnone size-full wp-image-661\" title=\"WonderfulExamples\" src=\"https:\/\/mathpirate.net\/log\/wp-content\/uploads\/2009\/11\/WonderfulExamples.png\" alt=\"WonderfulExamples\" width=\"649\" height=\"312\" srcset=\"https:\/\/mathpirate.net\/log\/wp-content\/uploads\/2009\/11\/WonderfulExamples.png 649w, https:\/\/mathpirate.net\/log\/wp-content\/uploads\/2009\/11\/WonderfulExamples-300x144.png 300w\" sizes=\"(max-width: 649px) 100vw, 649px\" \/><\/a><\/p>\n<p>Besides the fact\u00c2\u00a0that this example is apparently showing something that&#8217;s invisible,\u00c2\u00a0it&#8217;s not even really showing the creation and initialization, either.\u00c2\u00a0 Calling your local functions &#8220;SetupEventHandlers()&#8221; and &#8220;LoadInitialGrammars()&#8221; isn&#8217;t exactly all that helpful to me.\u00c2\u00a0 I understand that I need to set up event handlers and load grammars.\u00c2\u00a0 THAT&#8217;S WHY I&#8217;M READING THE DOCUMENTATION:\u00c2\u00a0 I know I need to do something, but I don&#8217;t know how.\u00c2\u00a0 You&#8217;ve pretty much shown me how to call the constructor on your class.\u00c2\u00a0 I managed to get that bit on my own, remarkably enough.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>So that&#8217;s how you create, initialize, and\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0\u00c2\u00a0 a SpeechRecognizer&#8230; Besides the fact\u00c2\u00a0that this example is apparently showing something that&#8217;s invisible,\u00c2\u00a0it&#8217;s not even really showing the creation and initialization, either.\u00c2\u00a0 Calling your local functions &#8220;SetupEventHandlers()&#8221; and &#8220;LoadInitialGrammars()&#8221; isn&#8217;t exactly all that helpful to me.\u00c2\u00a0 I understand that I need to set up event handlers and load [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[84],"tags":[10,11,15,31,14,23,85],"_links":{"self":[{"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/posts\/660"}],"collection":[{"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/comments?post=660"}],"version-history":[{"count":1,"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/posts\/660\/revisions"}],"predecessor-version":[{"id":662,"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/posts\/660\/revisions\/662"}],"wp:attachment":[{"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/media?parent=660"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/categories?post=660"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mathpirate.net\/log\/wp-json\/wp\/v2\/tags?post=660"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}