trek

##Docs Audit Postmortem

In preparation for the Ember.js 1.0 release we performed a documentation audit of the YUIDoc-formatted inline API documentation that becomes the text of http://emberjs.com/api/.

The goal of this audit was three-fold:

• verify each documented API for correctness
• add documentation to public APIs that were undocumented
• update examples that are no longer considered best practices

trek

<script type="text/x-handlebars">
  <h2>Welcome to Ember.js</h2>
 
   {{input type="text" value=searchText placeholder="Search..."}}
   <ul>
   {{#each searchResults}}
      <li>{{this}}</li>
   {{/each}}
  </ul>
</script>

trek

.ember-view .tooltip {
  display:none;
}
.ember-view.tip-visible .tooltip {
  display:block;
}

trek

App = Ember.Application.create();
App.ExampleController = Ember.Controller.extend({
  select: function(){
    console.log("an example image was clicked");
  }
});

trek

var each = require('my-array-lib').eachMethod,
    Array = require('stdlib/array');
 
Array.prototype.forEach = each; // only way to be sure nobody is up to something tricky.

trek

var each = require('my-array-lib-without-demons/each').eachMethod,
    Array = require('stdlib/array');

Array.prototype.forEach = each; // only way to be sure nobody is up to something tricky.

trek

      Class.new(Parameters, &@block).new(value).tap do |p|
        unless p.valid?
          record.errors.add(attribute, :invalid, options.merge(:value => value))
        end
      end

trek

<div style="display:inline-block; background-color:#fff">
  <img src='http://emberjs.com/images/community/outdated.png' style="float:left;">
  <p style="margin-left:115px; font-color:#1e1e1e;">
    <em>Hey!</em> This article references a pre-release version of Ember.js. Now that Ember.js has reached a 1.0 API the code samples below are no longer correct and the expressed opinions <em>may</em> no longer be accurate.
  </p>
</div>

trek

{{view Ember.TextField 
       valueBinding="storeCard.relevantDate" 
       classNames="timepicker-default input-small"
}}
<span class='add-on'><i class="icon-time"></i></span>

trek

ChangeStateOnTextEntry = Em.TextField.extend({
  insertNewline: function(){
    this.get('controller.target').send('someRouterEventName')
  }
})