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.

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

Improve documentation of EmberArray #18228

Open
locks opened this issue Aug 6, 2019 · 7 comments

Comments

@locks
Copy link
Contributor

commented Aug 6, 2019

Going through http://api.emberjs.com/ember/release/classes/EmberArray, you will notice that some of the entries have minimal documentation and no code sample.
The goal is to review each entry, add code samples where missing, and optionally improve the prose.

Please comment in this thread if you pick one of the entries so it can be assigned to you!

Methods

Properties

  • []
  • firstObject
  • hasArrayObservers
  • lastObject
  • length
@barryofguilder

This comment has been minimized.

Copy link

commented Aug 8, 2019

I'd like to take a stab at findBy.

@sdebarros

This comment has been minimized.

Copy link
Contributor

commented Aug 8, 2019

I've submitted a code example for every, and would also like to review/add example for filter, filterBy and addArrayObserver.

sukima added a commit to sukima/ember.js that referenced this issue Aug 8, 2019
Update documentation for EmberArray.any
Prior to this change, the wording was inaccurate. It was describing
filtering not the short circuit behaviour of `any()`.

This change attempts to fix that discrepancy and expand on the example
to include both context option and arrow function use.

Issue emberjs#18228
sukima added a commit to sukima/ember.js that referenced this issue Aug 8, 2019
Update documentation for EmberArray.any
Prior to this change, the wording was inaccurate. It was describing
filtering not the short circuit behaviour of `any()`.

This change attempts to fix that discrepancy and expand on the example
to include both context option and arrow function use.

Issue emberjs#18228
@mukilane

This comment has been minimized.

Copy link
Contributor

commented Aug 18, 2019

I'd like to take invoke and setEach.

@mukilane

This comment has been minimized.

Copy link
Contributor

commented Aug 21, 2019

Added an example for [] property. #18293

@flashios09

This comment has been minimized.

Copy link

commented Aug 27, 2019

we can stole 🤓 some examples from cakephp collection class
image

brunoocasali added a commit to brunoocasali/ember.js that referenced this issue Aug 28, 2019
Update documentation for EmberArray.find
Add code examples for `EmberArray.find` method.

Issue emberjs#18228
@mukilane

This comment has been minimized.

Copy link
Contributor

commented Sep 1, 2019

Can we add @readonly tag for properties like firstObject and lastObject ?

@imkathir

This comment has been minimized.

Copy link

commented Sep 2, 2019

@locks I'd like to take map and mapBy methods.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.