Browse Source

Merge pull request #2066 from blink1073/fix-rendermime-docs

Update rendermime docs
Afshin Darian 8 years ago
parent
commit
12f3e2eecd
1 changed files with 3 additions and 12 deletions
  1. 3 12
      packages/rendermime/src/rendermime.ts

+ 3 - 12
packages/rendermime/src/rendermime.ts

@@ -45,18 +45,9 @@ import {
 /**
  * A composite renderer.
  *
- * #### Notes
- * When rendering a mimebundle, a mimeType is selected from the mimeTypes by
- * searching through the `this.order` list. The first mimeType found in the
- * bundle determines the renderer that will be used.
- *
- * You can add a renderer by adding it to the `renderers` object and
- * registering the mimeType in the `order` array.
- *
- * Untrusted bundles are handled differently from trusted ones.  Untrusted
- * bundles will only render outputs that can be rendered "safely"
- * (see [[RenderMime.IRenderer.isSafe]]) or can be "sanitized"
- * (see [[RenderMime.IRenderer.isSanitizable]]).
+ * The renderer is used to render mime models using registered
+ * mime renderers, selecting the preferred mime renderer to
+ * render the model into a widget.
  */
 export
 class RenderMime {