can.Mustache Documentation Review

bitovi / canjs.com

The CanJS homepage and distributable files

17 stars 12 forks source link

General notes:

All page titles are referencing JavascriptMVC. Is that intentional?

We should be consistent in wording flow for code snippets when showing template/data/result (for example in some places"rendering/with/results in" is used, in others "the template/and data/results in").

can.Mustache

http://canjs.com/docs/can.Mustache.html

[x] typo: double use of word "contain" ("normal HTML except they contain contain").

[x] wording: "This updates the text to say" should probably be "This updtates the HTML to" in order to match "HTML Result" earlier in the document

[x] wording: "can.Mustache provides a lot more functionality such as"… use of "a lot" probably not optimal. How about "can.Mustache provides significantly more functionality, such as"

[x] broken link: "sections" (into the template and sections)

[x] broken links: * Context and Path Basics * Sections * Partials * Acquiring Templates * Helpers * Live Binding

helper

http://canjs.com/docs/can.Mustache.helper.html

[x] typo: elemnet's ("the following helper two-way binds input elemnet's value")

[x] most of the code snippets on this page are missing semicolons on most lines

[x] HTML tags should be lowercase for consistency (LI, SPAN)

helperOptions

http://canjs.com/docs/can.Mustache.helperOptions.html

[x] typo: pass should be passed ("The options argument pass to a helper function.")

Basics

http://canjs.com/docs/can.Mustache.Basics.html

[x] Keys code snippet: double indentation for 'name'

[x] Broken links in "Context Jumping" paragraph (sections & helpers)

Sections

http://canjs.com/docs/can.Mustache.Sections.html

[x] typo: missing the word 'with' ("begin a bang (!)")

Template Acquisition

http://canjs.com/docs/can.Mustache.Acquisition.html

[x] typo: 'its own file' should be 'their own files' ("Templates can be defined in its own file")

[x] code snippet in URL section missing semicolon on Line 1

[x] wording change: "Since could potentially make several XHR requests, in a big application this could be a performance concern" change to "Since this could potentially make several XHR requests, in a big application performance could be a concern"

[x] Remove line break before "If you are using Steal…". Also wording suggestion: "If you are using Steal, this will be done automatically for you at build"

Helpers

http://canjs.com/docs/can.Mustache.Helpers.html#Sections

[x] broken link in "if" paragraph (sections)

[x] broken link in "else" paragraph (sections)

[x] typo: space needed between words "The" and "each" ("Theeach")

[x] broken links in "each" paragraph (sections, basics of contexts)

[x] typo in "each" paragraph: "its" should be "it's" ("the value for which its iterating")

[x] broken link in "with" paragraph (sections)

[x] typos in "Element Callbacks" paragraph: "its" should be "it's" ("its easy to define"), delete the word "for" ("element for which is passed")

[x] broken link in "Evaluating Helpers" paragraph (section)

[x] typo in "Evaluating Helpers" paragraph: remove word "as" ("If you want to use a helper with as a section")

[x] broken link in "Advanced Helpers" paragraph (section)

[x] typo in "Advanced Helpers" paragraph: remove comma after "Whereas" ("Whereas, an empty data object would output")

Live Binding

http://canjs.com/docs/can.Mustache.Binding.html

[x] wording change: first sentence is awkward. Change to something like "Live binding refers to templates which update themselves as the data used in the magic tags change"

[x] typo: "living-binding" should be "live binding" ("adds the hooks for living-binding automatically")

[x] typo: add the word "documentation" to the last sentence after the can.Observe link ("For more information visit the can.Observe.")

Thanks! For small typo's please make the changes yourself.

Sent from my iPhone

On Aug 2, 2013, at 4:47 PM, rywhee notifications@github.com wrote:

General notes:

All page titles are referencing JavascriptMVC. Is that intentional? We should be consistent in wording flow for code snippets when showing template/data/result (for example in some places"rendering/with/results in" is used, in others "the template/and data/results in"). can.Mustache

http://canjs.com/docs/can.Mustache.html

typo: double use of word "contain" ("normal HTML except they contain contain"). wording: "This updates the text to say" should probably be "This updtates the HTML to" in order to match "HTML Result" earlier in the document wording: "can.Mustache provides a lot more functionality such as"… use of "a lot" probably not optimal. How about "can.Mustache provides significantly more functionality, such as" broken link: "sections" (into the template and sections) broken links: * Context and Path Basics * Sections * Partials * Acquiring Templates * Helpers * Live Binding helper

http://canjs.com/docs/can.Mustache.helper.html

typo: elemnet's ("the following helper two-way binds input elemnet's value") most of the code snippets on this page are missing semicolons on most lines HTML tags should be lowercase for consistency (LI, SPAN) helperOptions

http://canjs.com/docs/can.Mustache.helperOptions.html

typo: pass should be passed ("The options argument pass to a helper function.") Basics

http://canjs.com/docs/can.Mustache.Basics.html

Keys code snippet: double indentation for 'name' Broken links in "Context Jumping" paragraph (sections & helpers) Sections

http://canjs.com/docs/can.Mustache.Sections.html

typo: missing the word 'with' ("begin a bang (!)") Template Acquisition

http://canjs.com/docs/can.Mustache.Acquisition.html

typo: 'its own file' should be 'their own files' ("Templates can be defined in its own file") code snippet in URL section missing semicolon on Line 1 wording change: "Since could potentially make several XHR requests, in a big application this could be a performance concern" change to "Since this could potentially make several XHR requests, in a big application performance could be a concern" Remove line break before "If you are using Steal…". Also wording suggestion: "If you are using Steal, this will be done automatically for you at build" Helpers

http://canjs.com/docs/can.Mustache.Helpers.html#Sections

broken link in "if" paragraph (sections) broken link in "else" paragraph (sections) typo: space needed between words "The" and "each" ("Theeach") broken links in "each" paragraph (sections, basics of contexts) typo in "each" paragraph: "its" should be "it's" ("the value for which its iterating") broken link in "with" paragraph (sections) typos in "Element Callbacks" paragraph: "its" should be "it's" ("its easy to define"), delete the word "for" ("element for which is passed") broken link in "Evaluating Helpers" paragraph (section) typo in "Evaluating Helpers" paragraph: remove word "as" ("If you want to use a helper with as a section") broken link in "Advanced Helpers" paragraph (section) typo in "Advanced Helpers" paragraph: remove comma after "Whereas" ("Whereas, an empty data object would output") Live Binding

http://canjs.com/docs/can.Mustache.Binding.html

wording change: first sentence is awkward. Change to something like "Live binding refers to templates which update themselves as the data used in the magic tags change" typo: "living-binding" should be "live binding" ("adds the hooks for living-binding automatically") typo: add the word "documentation" to the last sentence after the can.Observe link ("For more information visit the can.Observe.") Context

http://canjs.com/docs/can.Mustache.context.html

incomplete first sentence ("Every part of a mustache template is rendered with") {{#key}}

http://canjs.com/docs/can.Mustache.helpers.section.html

typo: change "its" to "it's" ("current context to the value for which its iterating") {{helper args hashes}}

http://canjs.com/docs/can.Mustache.helpers.helper.html

wording change: change "…Mustache helper functions that may do more complex functionality" to something like "…Mustache helper functions that may contain more complex functionality" {{#each key}}

http://canjs.com/docs/can.Mustache.helpers.each.html

typo: "itterate" should be "iterate" and "over a array" should be "over an array" ("Use the each helper to itterate over a array of items") {{data name}}

http://canjs.com/docs/can.Mustache.helpers.data.html

typo: "Its" should be "It's" ("Its common you want some data in the template") {{>key}}

http://canjs.com/docs/can.Mustache.helpers.partial.html

typo: "{{>user.mustaceh}}" should be "{{>user.mustache}}" wording change: "Partials can resolve the context object that contain partial identifiers in them" is awkward, should be changed to something like "Partials can resolve the context object that contains partial identifiers" — Reply to this email directly or view it on GitHub.

bitovi / canjs.com