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

(fix): clarify public backed sparse docstring/api #1608

Merged
merged 24 commits into from
Aug 30, 2024

Conversation

ilan-gold
Copy link
Contributor

For #1598 (review)

Perhaps should go in separately to main as it is a cleaner git blame IMO

  • Closes #
  • Tests added
  • Release note added (or unnecessary)

Copy link

codecov bot commented Aug 26, 2024

Codecov Report

Attention: Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 84.30%. Comparing base (94b2304) to head (94746c2).
Report is 67 commits behind head on main.

Files with missing lines Patch % Lines
src/anndata/_core/sparse_dataset.py 87.50% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1608      +/-   ##
==========================================
- Coverage   86.83%   84.30%   -2.54%     
==========================================
  Files          37       37              
  Lines        6016     6000      -16     
==========================================
- Hits         5224     5058     -166     
- Misses        792      942     +150     
Files with missing lines Coverage Δ
src/anndata/_core/sparse_dataset.py 92.23% <87.50%> (-0.70%) ⬇️

... and 8 files with indirect coverage changes

@flying-sheep
Copy link
Member

So you want us to commit to the whole API?

If not necessarily: There are ways to make users see only part of it, I can help with that.

@ilan-gold
Copy link
Contributor Author

If not necessarily: There are ways to make users see only part of it, I can help with that.

Sorry went to lunch before getting to that. I made private what I thought should be, and left what I thought should be public as such. Feel free to comment otherwise

Copy link
Member

@flying-sheep flying-sheep left a comment

Choose a reason for hiding this comment

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

Awesome! I don’t think we want people to manually initialize it, but I think not much harm is done if they try do do that.

Base automatically changed from ig/{read,write}_elem_out_of_experimental to main August 30, 2024 12:28
@ilan-gold ilan-gold enabled auto-merge (squash) August 30, 2024 13:35
@ilan-gold ilan-gold disabled auto-merge August 30, 2024 13:37
@flying-sheep flying-sheep enabled auto-merge (squash) August 30, 2024 13:45
@ilan-gold ilan-gold disabled auto-merge August 30, 2024 13:57
@ilan-gold ilan-gold merged commit 53537b5 into main Aug 30, 2024
15 checks passed
@ilan-gold ilan-gold deleted the ig/csr_csc_public_prep branch August 30, 2024 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants