mithril-vndb/docs
pelonpelon b48f8bf79c Docs: mithril.component.md - Recommended changes
These changes make the the text clearer to me. I did not want to change the voice of the text, but I tried to clear out some verbosity and improve consistency. I did my best not to interfere with the logic of the prose.

This document seems written to stand on its own, so I recommend the following changes:

- a general explanation of the args param as in `controller: function(args) {` and `view: function(ctrl, args) { ...` (when first used, well before the signature)
- a specific explanation of {data: args} in m.request() (mithril.request.md could use the same treatment)
- an explanation of the extras param as in `controller: function(args, extras) {` and `view: function(ctrl, args, extras) { ...`
- the term *rollback* should be explained or replaced
- caveat #3/#4: Should *root element* be changed to *top-most element* so as not to be confused with the element the component is mounted on ?
- in testing, explain why the first param to view is `null`

I hope you can find some of this useful.
2015-04-29 12:39:10 -05:00
..
layout clean up markup for tweets 2015-04-22 22:03:12 -04:00
auto-redrawing.md improve docs about redrawing 2015-04-20 22:16:27 -04:00
benchmarks.md add section about todomvc benchmark 2014-12-31 16:39:17 -05:00
change-log.md update change log 2015-04-20 22:19:58 -04:00
community.md change order in community page 2015-03-24 23:56:22 -04:00
comparison.md update size 2015-04-22 21:18:55 -04:00
components.md remove references to m.module 2015-04-22 21:18:41 -04:00
getting-started.md add some points to address common criticism 2015-04-22 22:46:01 -04:00
how-to-read-signatures.md improve docs 2014-09-14 00:52:11 -04:00
installation.md fix docs about using bleeding edge from npm 2015-04-15 22:41:15 -04:00
integration.md rework api 2015-04-09 22:44:45 -04:00
mithril.component.md Docs: mithril.component.md - Recommended changes 2015-04-29 12:39:10 -05:00
mithril.computation.md improve docs about redrawing 2015-04-20 22:16:27 -04:00
mithril.deferred.md Small change to example code 2015-02-01 00:59:46 -07:00
mithril.deps.md fix formatting in docs 2014-09-27 21:01:00 -04:00
mithril.md remove outdated warning 2015-04-27 22:02:12 -04:00
mithril.mount.md rework api 2015-04-09 22:44:45 -04:00
mithril.prop.md rework api 2015-04-09 22:44:45 -04:00
mithril.redraw.md improve docs 2015-04-21 08:20:00 -04:00
mithril.render.md add missing return 2015-03-30 10:55:34 -04:00
mithril.request.md improve docs 2015-04-24 08:22:42 -04:00
mithril.route.md update docs about config: m.route 2015-04-22 20:32:39 -04:00
mithril.sync.md fixing links 2014-08-12 18:00:54 -04:00
mithril.trust.md Copy edit docs 2014-05-26 23:51:16 -05:00
mithril.withAttr.md changes in the docs: rename modules to components, change idiomatic controller and view usage 2015-04-06 22:41:38 -04:00
optimizing-performance.md #307 fix compiler bugs 2014-10-13 21:22:38 -04:00
practices.md remove references to m.module 2015-04-22 21:18:41 -04:00
roadmap.md initial release 2014-03-16 22:07:53 -04:00
routing.md remove references to m.module 2015-04-22 21:18:41 -04:00
tools.md tools.md: explicitly say IE8 needs polyfills 2015-02-23 00:39:05 -05:00
web-services.md changes in the docs: rename modules to components, change idiomatic controller and view usage 2015-04-06 22:41:38 -04:00