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

Docs: fix typo in documentation #1326

Merged
merged 4 commits into from
Mar 1, 2022
Merged

Docs: fix typo in documentation #1326

merged 4 commits into from
Mar 1, 2022

Conversation

agoose77
Copy link
Collaborator

@agoose77 agoose77 commented Feb 28, 2022

  • Drop documentation of ak.highlevel.ArrayBuilder.extend
  • Drop documentation of ak.layout.ArrayBuilder.extend
  • Drop documentation of ak.layout.ArrayBuilder.append
  • Fix typo of ArrayBuilder

Also, should we drop mention of `extend` here given that we haven't implemented it?
@agoose77 agoose77 added the docs Improvements or additions to documentation label Feb 28, 2022
@codecov
Copy link

codecov bot commented Feb 28, 2022

Codecov Report

Merging #1326 (859daf9) into main (5613d44) will decrease coverage by 1.63%.
The diff coverage is 48.21%.

Impacted Files Coverage Δ
src/awkward/_v2/_connect/cling.py 0.00% <0.00%> (ø)
src/awkward/_v2/contents/listoffsetarray.py 80.52% <ø> (+0.10%) ⬆️
src/awkward/_v2/operations/structure/ak_unzip.py 75.00% <ø> (ø)
...wkward/_v2/operations/structure/ak_argcartesian.py 73.33% <66.66%> (-1.67%) ⬇️
...ard/_v2/operations/structure/ak_argcombinations.py 76.92% <70.00%> (+1.92%) ⬆️
...wkward/_v2/operations/structure/ak_combinations.py 90.90% <87.50%> (+15.90%) ⬆️
...c/awkward/_v2/operations/structure/ak_cartesian.py 89.34% <89.07%> (+14.34%) ⬆️
src/awkward/_v2/_lookup.py 97.50% <97.50%> (ø)
src/awkward/_v2/__init__.py 100.00% <100.00%> (ø)
src/awkward/_v2/_connect/numba/arrayview.py 96.76% <100.00%> (+0.51%) ⬆️
... and 28 more

@jpivarski
Copy link
Member

Yes, please drop references to the extend method, since that's an old one that was removed. It used to have a different meaning than just calling append many times, now it wouldn't, if it were to exist.

@agoose77
Copy link
Collaborator Author

agoose77 commented Mar 1, 2022

I should have realised that it was just as likely that it was removed as added!

Copy link
Member

@jpivarski jpivarski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! If it's ready to go, you can merge it.

@agoose77 agoose77 merged commit 81b8b2b into main Mar 1, 2022
@agoose77 agoose77 deleted the agoose77-patch-1 branch March 1, 2022 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants