Opened 11 years ago

Closed 11 years ago

#10024 closed enhancement (fixed)

dijit._Templated documentation could describe limitations better

Reported by: jhartikainen Owned by: bill
Priority: high Milestone: 1.4
Component: Documentation Version: 1.3.2
Keywords: Cc:
Blocked By: Blocking:


I was trying to locate information on dijit._Templated's limitations, primarily whether it was designed to support having multiple root-level nodes in the template or not.

I skimmed over the docs at DojoCampus?, but was unable to find anything. However, it was later pointed out on the IRC channel that the page for dijit._Templated said that templates can only have a single root node.

I would suggest the documentation for dijit._Templated be improved by including a list of main points the programmer should know of - such as "only one root level node" - perhaps in the form of a bullet point list. This will make skimming the documentation much easier, and will make finding relevant information faster.

Change History (2)

comment:1 Changed 11 years ago by bill

Milestone: tbd1.4
Owner: set to bill
Status: newassigned

Hmm, I'm not sure that qualifies as "main point" more than anything else on that page, and I note that "single root node" is the first sentence in the section on templates... but I'lI add a "common pitfalls" section at the end, hopefully that will help some folks.

comment:2 Changed 11 years ago by bill

Resolution: fixed
Status: assignedclosed
Note: See TracTickets for help on using tickets.