ember-api-docs icon indicating copy to clipboard operation
ember-api-docs copied to clipboard

Some Classes don't show inline examples

Open toddjordan opened this issue 8 years ago • 2 comments

Some of the inline examples aren't showing up because their names don't match up with the name in mappings.json

doc name mappings name
Adapter TestAdapter
EmberObject Object
ContainerProxyMixin none
EmberArray Array
EmberError Error
EventTarget none
Promise no localName
Router EmberRouter
  • [x] Adapter
  • [x] EmberObject
  • [x] ContainerProxyMixin
  • [x] EmberArray
  • [x] EmberError
  • [x] EventTarget
  • [ ] Promise
  • [x] Router

toddjordan avatar Jan 11 '18 05:01 toddjordan

Promise is interesting... its the only place where a class is not using the default import, and instead we want folks to use import { Promise } from 'rsvp';. Interesting that we didn't do import Promise from 'rsvp/promise'; instead.

toddjordan avatar Feb 01 '18 15:02 toddjordan

Regardless, working on a PR to do some more smart reading of mappings.json to detect non-default class imports.

toddjordan avatar Feb 01 '18 15:02 toddjordan