can-define Documentations Issues Continued: can-define/list/list

Documentations Issues Continued: can-define/list/list

Open indifferentghost opened this issue 6 years ago • 1 comments

This is a continuation of issue #362 separated for can-define/list/list. It was separated to provide amiable and more accurate estimates.

can-define/list/list

[ ] codepen-able and loggable examples.
[ ] I'm not sure of the validity of having {can-define/list/list} in the Returns subheading on new DefineList([items]) linking to the page it's currently on.

can-define/list/list/AddEvent.html

[ ] A codepen-able example with syntax highlighting.
[ ] Article is a stub and probably should be expendanded, at least with a Use section.

can-define/list/list/LengthEvent.html

[ ] A codepen-able example with syntax highlighting.
[ ] Article is a stub and probably should be expanded, at least with a Use section.

can-define/list/list/PropertyNameEvent.html

[ ] A codepen-able example with syntax highlighting.
[ ] Article is a stub and probably should be expanded, at least with a Use section.

can-define/list/list/RemoveEvent.html

[ ] A codepen-able example with syntax highlighting.
[ ] Article is a stub and probably should be expanded, at least with a Use section.

can-define/list/list.prototype.assign.html

[x] A codepen-able example with syntax highlighting.
[ ] Article is a stub and probably should be expanded, at least with a Use section.
[x] Needs ES6 syntax.

can-define/list/list.prototype.assignDeep.html

[x] A codepen-able example with syntax highlighting.
[ ] Article is a stub and probably should be expanded, at least with a Use section.
[x] Needs ES6 syntax.

can-define/list/list.prototype.concat.html

[ ] Signature needs an example.
[x] Use needs syntax highlighting.
[x] ES6 syntax.

can-define/list/list.prototype.every.html

[x] syntax highlighting.
[x] codepen-able examples.
[ ] Needs a use section.
[x] Needs ES6 syntax.

can-define/list/list.prototype.filter.html

[x] syntax highlighting.
[x] codepen-able examples.
[ ] Needs a use section.
[x] Needs ES6 syntax.

can-define/list/list.prototype.forEach.html

[x] syntax highlighting.
[x] codepen-able examples.
[x] Needs ES6 syntax.
[ ] Use should probably be expanded.

can-define/list/list.prototype.get.html

[x] codepen-able examples.
[x] Needs ES6 syntax.
[ ] Needs Use section.

can-define/list/list.prototype.indexOf.html

[x] codepen-able examples.
[x] Needs ES6 syntax.
[ ] Article is a stub. Needs Use section.
[x] Syntax highlighting.

can-define/list/list.prototype.join.html

[x] codepen-able examples.
[x] Needs ES6 syntax.
[x] Syntax highlighting.
[ ] Article is a stub. Needs a Use section.

can-define/list/list.prototype.lastIndexOf.html

[x] codepen-able examples.
[x] Needs ES6 syntax.
[x] Syntax highlighting.
[ ] Article is a stub. Needs a Use section.

can-define/list/list.prototype.map.html

[x] codepen-able examples.
[x] Needs ES6 syntax.
[ ] Needs a Use section.

can-define/list/list.prototype.pop.html

[x] codepen-able examples.
[x] Needs ES6 syntax.
[x] Syntax highlighting.

can-define/list/list.prototype.push.html

[x] codepen-able examples.
[x] Needs ES6 syntax.
[x] Syntax highlighting

can-define/list/list.prototype.reduce.html

[x] Needs ES6 syntax.
[x] codepen-able examples.
[ ] Needs a Use section.

can-define/list/list.prototype.reduceRight.html

[x] Needs relevant example. (example currently is using reduce.)
[x] codepen-able example.
[ ] Needs a Use section.

can-define/list/list.prototype.replace.html

[x] Syntax highlighting.
[x] codepen-able example.
[x] Needs ES6 syntax.
[ ] Article is a stub.

can-define/list/list.prototype.reverse.html

[x] Syntax highlighting
[x] Needs ES6 syntax.
[ ] Article is a stub.
[x] codepen-able example.
[ ] Link DefineList main article.

can-define/list/list.prototype.serialize.html

[x] Syntax highlighting
[x] Needs ES6 syntax.
[ ] Article is a stub.
[x] codepen-able example.

can-define/list/list.prototype.set.html

[x] Needs ES6 syntax.
[x] codepen-able example.
[ ] Notification of deprecation from main menu?

can-define/list/list.prototype.shift.html

[x] Syntax highlighting
[x] Needs ES6 syntax.
[ ] Article is a stub.
[x] codepen-able example.

can-define/list/list.prototype.slice.html

[x] Syntax highlighting
[x] Needs ES6 syntax.
[x] codepen-able example.

can-define/list/list.prototype.some.html

[x] Syntax highlighting
[x] Needs ES6 syntax.
[x] codepen-able example.
[ ] Missing Use section.

can-define/list/list.prototype.sort.html

[x] Needs ES6 syntax.
[x] codepen-able example.
[ ] Missing Use section.
[x] Open and empty example after the signature.

can-define/list/list.prototype.splice.html

[x] Needs ES6 syntax.
[x] codepen-able example.
[x] Syntax highlighting.
[ ] Signature needs basic example.

can-define/list/list.prototype.unshift.html

[x] Needs ES6 syntax.
[x] codepen-able example.
[x] Syntax highlighting.

can-define/list/list.prototype.update.html

[x] Needs ES6 syntax.
[x] codepen-able example.
[ ] Article is a stub. Needs Use section.

can-define/list/list.prototype.updateDeep.html

[x] Needs ES6 syntax.
[x] codepen-able example.
[ ] Article is a stub. Needs Use section.

can-define/list/list.prototype.wildcard.html

[ ] codepen-able example.
[ ] Article is a stub. Needs a Use section.

can-define/list/list.prototype.wildcardItems.html

[ ] codepen-able example.
[ ] Article is a stub. Needs a Use section.

can-define/list/list.extend.html

[ ] codepen-able example.
[ ] Article is a stub. Needs a Use section.

discussion:

The events subsection and prototype subsection have different route styles. It would be good to keep one style across documentation. This seems to stem from a difference of how documentation is being produced. The prototype methods have their documentation written in the main list.js file.

can-define/list/list/AddEvent.html vs: can-define/list/list.prototype.assign.html

Would it be prudent to compare related functions to either MDN or variants like assignDeep on Map and List?

Pop has a See Also section, should this be implemented as a standard?

[ ] Document added and remove #403

Aug 16 '18 16:08 indifferentghost

Regarding:

I'm not sure of the validity of having {can-define/list/list} in the Returns subheading on new DefineList([items]) linking to the page it's currently on.

I agree. Though we don't have a great way to distinguish instances from constructors. This would certainly be useful.

Aug 16 '18 18:08 justinbmeyer

can-define can-define copied to clipboard

Documentations Issues Continued: can-define/list/list

discussion:

can-define
can-define copied to clipboard