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

Improve documentation of EmberArray #18228

Closed
26 of 38 tasks
locks opened this issue Aug 6, 2019 · 21 comments
Closed
26 of 38 tasks

Improve documentation of EmberArray #18228

locks opened this issue Aug 6, 2019 · 21 comments
Labels
Documentation Help Wanted

Comments

@locks
Copy link
Contributor

locks commented Aug 6, 2019 •
edited
Loading

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
@sukima sukima mentioned this issue Aug 6, 2019
Merged
@barryofguilder
Copy link

I'd like to take a stab at findBy.

@barryofguilder barryofguilder mentioned this issue Aug 8, 2019
Merged
This was referenced Aug 8, 2019
Merged
Merged
@sdebarros
Copy link
Contributor

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
@sukima
Update documentation for EmberArray.any
711d4fa 
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
@sukima
Update documentation for EmberArray.any
2ee24e1 
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
@sdebarros sdebarros mentioned this issue Aug 8, 2019
Merged
@sdebarros sdebarros mentioned this issue Aug 16, 2019
Merged
@mukilane
Copy link
Contributor

I'd like to take invoke and setEach.

This was referenced Aug 18, 2019
Merged
Merged
Merged
@mukilane
Copy link
Contributor

Added an example for [] property. #18293

@jayjayjpg jayjayjpg mentioned this issue Aug 22, 2019
Merged
9 tasks
@mukilane mukilane mentioned this issue Aug 24, 2019
Merged
@flashios09
Copy link

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
@brunoocasali
Update documentation for EmberArray.find
9f6bece 
Add code examples for `EmberArray.find` method.

Issue emberjs#18228
@brunoocasali brunoocasali mentioned this issue Aug 28, 2019
Merged
@mukilane mukilane mentioned this issue Sep 1, 2019
Merged
@mukilane
Copy link
Contributor

mukilane commented Sep 1, 2019

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

@imkathir
Copy link

imkathir commented Sep 2, 2019 •
edited
Loading

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

@imkathir imkathir mentioned this issue Sep 11, 2019
Merged
This was referenced Sep 14, 2019
Merged
Merged
@beegan beegan mentioned this issue Oct 1, 2019
Merged
@beegan
Copy link
Contributor

beegan commented Oct 1, 2019

Hey @locks. Picked up rejectBy there in #18447. Will try pick off a few others that look light at the minute.

@beegan
Copy link
Contributor

beegan commented Oct 3, 2019

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

@Frozenfire92
Copy link
Contributor

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

This was referenced Oct 4, 2019
Merged
Merged
Merged
Merged
locks added a commit that referenced this issue Oct 9, 2019
@locks
Merge pull request #18465 from Frozenfire92/18228-includes
1259e64 
[DOC] #18228 Update documentation for EmberArray.includes
rwjblue added a commit that referenced this issue Oct 10, 2019
@rwjblue
[DOC] #18228 Update documentation and examples for EmberArray.… (#18466)
9a09374 
[DOC] #18228 Update documentation and examples for EmberArray.indexOf
@vinodhrajamuralidharan
Copy link

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

@mcfiredrill mcfiredrill mentioned this issue Oct 23, 2019
Merged
@mcfiredrill
Copy link
Contributor

I added an example for reject. #18503

This was referenced Oct 23, 2019
Merged
Closed
@mcfiredrill
Copy link
Contributor

Took a stab at isAny and isEvery as well. #18505 #18506

@locks
Copy link
Contributor Author

locks commented Oct 23, 2019

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

@mcfiredrill
Copy link
Contributor

@locks Sure, that should make my PRs easier to read! 👍
#18507

This was referenced Oct 23, 2019
Closed
Merged
Merged
@Charizard
Copy link
Contributor

@locks Would like to pickup reject and rejectBy.

@Charizard Charizard mentioned this issue Oct 25, 2019
Closed
@Charizard
Copy link
Contributor

@locks Looks like rejectBy is already done

@mcfiredrill
Copy link
Contributor

@Charizard I made one for reject here. 😅 #18503

@Charizard
Copy link
Contributor

@mcfiredrill Oops! Sorry 😓

locks added a commit that referenced this issue Oct 26, 2019
@locks
Merge pull request #18464 from Frozenfire92/18228-getEach
648c6c3 
[DOC] #18228 Add description and example to EmberArray.getEach documentation
@locks
Copy link
Contributor Author

locks commented Oct 26, 2019

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

@locks
Copy link
Contributor Author

locks commented Oct 26, 2019

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.

@locks locks closed this as completed Oct 26, 2019
pzuraq pushed a commit that referenced this issue Nov 7, 2019
[DOC] #18228 Add example to EmberArray.forEach documentation (#18463)
5e5de19 
[DOC] #18228 Add example to EmberArray.forEach documentation
rwjblue pushed a commit that referenced this issue Nov 22, 2019
@rwjblue
[DOC] #18228 Add example to EmberArray.forEach documentation (#18463)
deceab2 
[DOC] #18228 Add example to EmberArray.forEach documentation

(cherry picked from commit 5e5de19)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Help Wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests