Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
indifferentghost opened this issue Aug 16, 2018 · 1 comment
Open

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

indifferentghost opened this issue Aug 16, 2018 · 1 comment
Labels
documentation p2

Comments

@indifferentghost
Copy link
Contributor

indifferentghost commented Aug 16, 2018 •
edited
Loading

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

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

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

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

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

  • Signature needs an example.
  • Use needs syntax highlighting.
  • ES6 syntax.

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

  • syntax highlighting.
  • codepen-able examples.
  • Needs a use section.
  • Needs ES6 syntax.

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

  • syntax highlighting.
  • codepen-able examples.
  • Needs a use section.
  • Needs ES6 syntax.

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

  • syntax highlighting.
  • codepen-able examples.
  • Needs ES6 syntax.
  • Use should probably be expanded.

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

  • codepen-able examples.
  • Needs ES6 syntax.
  • Needs Use section.

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

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

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

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

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

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

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

  • codepen-able examples.
  • Needs ES6 syntax.
  • Needs a Use section.

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

  • codepen-able examples.
  • Needs ES6 syntax.
  • Syntax highlighting.

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

  • codepen-able examples.
  • Needs ES6 syntax.
  • Syntax highlighting

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

  • Needs ES6 syntax.
  • codepen-able examples.
  • Needs a Use section.

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

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

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

  • Syntax highlighting.
  • codepen-able example.
  • Needs ES6 syntax.
  • Article is a stub.

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

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

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

  • Syntax highlighting
  • Needs ES6 syntax.
  • Article is a stub.
  • codepen-able example.

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

  • Needs ES6 syntax.
  • codepen-able example.
  • Notification of deprecation from main menu?

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

  • Syntax highlighting
  • Needs ES6 syntax.
  • Article is a stub.
  • codepen-able example.

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

  • Syntax highlighting
  • Needs ES6 syntax.
  • codepen-able example.

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

  • Syntax highlighting
  • Needs ES6 syntax.
  • codepen-able example.
  • Missing Use section.

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

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

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

  • Needs ES6 syntax.
  • codepen-able example.
  • Syntax highlighting.
  • Signature needs basic example.

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

  • Needs ES6 syntax.
  • codepen-able example.
  • Syntax highlighting.

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

  • Needs ES6 syntax.
  • codepen-able example.
  • Article is a stub. Needs Use section.

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

  • Needs ES6 syntax.
  • 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?
@indifferentghost indifferentghost self-assigned this Aug 16, 2018
@justinbmeyer
Copy link
Contributor

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.

@indifferentghost indifferentghost mentioned this issue Aug 24, 2018
Merged
71 tasks
@justinbmeyer justinbmeyer mentioned this issue Aug 27, 2018
Merged
indifferentghost added a commit that referenced this issue Aug 28, 2018
@indifferentghost
Updated examples to can-define/list/list. (#377)
1986d97 
Fixes a majority of #370.

* get documentation moved and updated to ES6 and are now codepenable. It was moved to prototype.get.md.

* set documentation moved and updated to ES6 and are now codepenable. It was moved to prototype.set.md.

* Assign documentation moved and updated to ES6 and are now codepenable. It was moved to prototype.assign.md.

* Moved update documentation to prototype.update.md updated examples to es6 and added codepen link.

* assignDeep documentation moved to prototype.assignDeep.md, syntax has also been updated for examples.

* updateDeep docs moved to prototype,updateDeep.md, ES6 syntax and links to codepen.

* Splice documentation moved to docs/prototype.splice.md. Highlighted and ES6'd syntax.

* Removed unnecessary spaing in docs/prototype.splice.md.

* serialize documentation moved to docs/prototype.serialize.md. Added syntax highlighting and updated to ES6 syntax. Example now links to codepen.

* push documentation moved to docs/prototype.push.md. Added syntax highlighting. Updated to ES6.

* Unshift documentation moved to docs/prototype.unshift.md. Examples link to codepen. Syntax highlighting. Updated to ES6.

* removed empty comment block.

* pop documentation moved to docs/prototype.pop.md. Examples have syntax highlighting, are Codepenable and in ES6 syntax.

* shift documentation was moved to docs/prototype.shift.md. Example links to codepen, has syntax highlighting and uses ES6 syntax.

* map documentation moved to docs/prototype.map.md. Example is using es6 syntax and linking to codepen.

* removed empty codeblock

* filter documentation moved to docs/prototype.filter.md. ES6 syntax highlighting, they're codepen-able.

* removed empty codeblock

* reduce documentation moved to docs/prototype.reduce.md. ES6 syntax and codepen-able.

* reduceRight documentation moved to docs/prototype.reduceRight.md. Updated syntax to ES6, provided example for reduceRight.

*  documentation moved to docs/prototype.every.md. Updated syntax to ES6 added syntax highlighting. Links to codepen.

* added imports to prototype.every.md examples

*  documentation moved to docs/prototype.some.md. ES6 syntax, highlighting and corrected the comments.

* indexOf documentation moved to docs/prototype.indexOf.md. Synxax highlighting, ES6 syntax.

* lastIndexOf documentation moved to docs/prototype.lastIndexOf. Added syntax highlighting and updated to ES6. changed IndexOf and lastIndexOf to double quotes to match the rest of the examples.

* join documentation moved to docs/prototype.join.md added syntax highlighting and es6. It's codepenable.

* reverse documentaiton moved to docs/prototype.reverse.md added syntax highlighting and es6. It's codepenable.

* removed semicolon from comments

* slice documentation has been moved to docs/prototype.slice.md. ES6 syntax and highlighting added. Examples are linked to codepen.

* concat documentation moved to docs/prototype.concat.md. Added syntax highlighting and ES6. Removed extra parenthesis from example.

* removed empty block comment

* forEach documentation moved to docs/prototype.forEach.md. Fixed example where it functions properly. ES6 and highlighted syntax. Links to codepen.

* replace documentation moved to docs/prototype.replace.md. examples are highlighted and using ES6 syntax. It's codepenable.

* sort documentation moved to docs/prototype.sort.md. Examples are highlighted and ES6. It's codepenable. Updated example to better relate to similarities across the documentation.

* Codepenable docs in define-list.md, updated to es6 syntax.

* fixes to assign

* up to concat tweeks

* removed unneeded @Body tag

* linting

* Fixed spacing across all prototype files

* Updated to ES6 syntax, Added semi-colons.

* fixed spelling error.

* Updated spacing for most examples to match some sort of cohesive style.

* changed quote to apostrophe

* removed redundant example.

* Added another example showing that justin object is mutated.

* updated events.propertyName.md example.

* example's style is now closer to the rest.

* Added syntax highlighting.

* Updated indexOf docs to note that it returns the index position of the item given

* Added an example if forEach returns false.

* changed reduce to reduce right.

* fixed spacing issues in prototype.concat.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation p2
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@justinbmeyer @chasenlehara @indifferentghost