Ember.js: Improve documentation of EmberArray

[locks]

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

• [x] addArrayObserver (@sdebarros) https://github.com/emberjs/ember.js/pull/18272
• [x] any (@sukima) https://github.com/emberjs/ember.js/pull/18229
• [ ] arrayContentDidChange
• [ ] arrayContentWillChange
• [ ] compact
• [x] every (@sdebarros) https://github.com/emberjs/ember.js/pull/18236
• [x] filter (@sdebarros) https://github.com/emberjs/ember.js/pull/18239
• [x] filterBy (@sdebarros) https://github.com/emberjs/ember.js/pull/18239
• [x] find (@brunoocasali) https://github.com/emberjs/ember.js/pull/18324
• [x] findBy (@barryofguilder) https://github.com/emberjs/ember.js/pull/18233
• [ ] forEach (@Frozenfire92) https://github.com/emberjs/ember.js/pull/18463
• [x] getEach (@Frozenfire92) https://github.com/emberjs/ember.js/pull/18464
• [x] includes (@Frozenfire92) https://github.com/emberjs/ember.js/pull/18465
• [x] indexOf (@Frozenfire92) https://github.com/emberjs/ember.js/pull/18466
• [x] invoke (@mukilane) https://github.com/emberjs/ember.js/pull/18283
• [x] isAny (@mcfiredrill) https://github.com/emberjs/ember.js/pull/18505
• [x] isEvery (@mcfiredrill) https://github.com/emberjs/ember.js/pull/18510
• [x] lastIndexOf (@Charizard) https://github.com/emberjs/ember.js/pull/18511
• [x] map (@imkathir) https://github.com/emberjs/ember.js/pull/18376
• [x] mapBy (@imkathir) https://github.com/emberjs/ember.js/pull/18376
• [x] objectAt
• [x] objectsAt
• [x] reduce
• [x] reject (@mcfiredrill) https://github.com/emberjs/ember.js/pull/18503
• [x] rejectBy (@beegan) https://github.com/emberjs/ember.js/pull/18447
• [ ] removeArrayObserver
• [x] setEach (@mukilane) https://github.com/emberjs/ember.js/pull/18287
• [ ] slice
• [x] sortBy (@mukilane) https://github.com/emberjs/ember.js/pull/18340
• [ ] toArray
• [ ] uniq
• [ ] uniqBy
• [ ] without

Properties

• [x] []
• [x] firstObject (@mukilane) https://github.com/emberjs/ember.js/pull/18386
• [x] hasArrayObservers (@mukilane) https://github.com/emberjs/ember.js/pull/18385
• [ ] lastObject
• [ ] length

[barryofguilder]

I'd like to take a stab at findBy.

[sdebarros]

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

[mukilane]

I'd like to take invoke and setEach.

[mukilane]

Added an example for [] property. #18293

[flashios09]

we can stole 🤓 some examples from cakephp collection class

[mukilane]

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

[imkathir]

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

[beegan]

Hey @locks. Picked up rejectBy there in https://github.com/emberjs/ember.js/pull/18447. Will try pick off a few others that look light at the minute.

[beegan]

rejectBy and reduce have been merged if you want to mark them off.

[Frozenfire92]

I'm going to start with forEach, getEach, includes, and indexOf

[vinodhrajamuralidharan]

@locks - I would like to take forEach, getEach, includes and indexOf

[mcfiredrill]

I added an example for reject. https://github.com/emberjs/ember.js/pull/18503

[mcfiredrill]

Took a stab at isAny and isEvery as well. https://github.com/emberjs/ember.js/pull/18505 https://github.com/emberjs/ember.js/pull/18506

[locks]

@mcfiredrill can you send the whitespace changes separately? that way I can merge it once and you can rebase your PRs!

[mcfiredrill]

@locks Sure, that should make my PRs easier to read! 👍
https://github.com/emberjs/ember.js/pull/18507

[Charizard]

@locks Would like to pickup reject and rejectBy.

[Charizard]

@locks Looks like rejectBy is already done

[mcfiredrill]

@Charizard I made one for reject here. 😅 https://github.com/emberjs/ember.js/pull/18503

[Charizard]

@mcfiredrill Oops! Sorry 😓

[locks]

Thank you for the help everyone :) I'm updating the issue at the moment.

[locks]

Excellent work everyone! Thank you once again for your help in pushing this forward :) Since most of the items are addressed, I'll be closing this issue and opening individual ones which are easier to keep track of.