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

Rely on scanpydoc for prose return sections #2800

Merged
merged 6 commits into from
Jan 9, 2024
Merged

Conversation

flying-sheep
Copy link
Member

@flying-sheep flying-sheep commented Jan 9, 2024

  • Closes N/A
  • Tests included or not required because:
  • Release notes not necessary because: docs change

Also bump scanpydoc so the [source] links for wrapped functions work.

E.g. sc.pp.filter_cells now links to the correct code lines):

-<a href="https://github.com/scverse/scanpy/tree/419c1a45aef26b5531a5b9cf1ec430e5ae67ce97/python3.11/site-packages/legacy_api_wrap/__init__.py#L49-L193">[source]</a>
+<a href="https://github.com/scverse/scanpy/tree/2d5bda1e45525354b9b751aa572c0b08175450cf/scanpy/preprocessing/_simple.py#L49-L193">[source]</a>

@flying-sheep flying-sheep added this to the 1.10.0 milestone Jan 9, 2024
Copy link

codecov bot commented Jan 9, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (9b08d35) 72.84% compared to head (2d5bda1) 72.84%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2800      +/-   ##
==========================================
- Coverage   72.84%   72.84%   -0.01%     
==========================================
  Files         111      111              
  Lines       12367    12368       +1     
==========================================
  Hits         9009     9009              
- Misses       3358     3359       +1     
Files Coverage Δ
scanpy/experimental/pp/_highly_variable_genes.py 63.46% <ø> (ø)
scanpy/external/pp/_hashsolo.py 89.74% <100.00%> (ø)
scanpy/external/pp/_scrublet.py 92.38% <ø> (ø)
scanpy/neighbors/__init__.py 77.47% <100.00%> (ø)
scanpy/preprocessing/_highly_variable_genes.py 96.17% <ø> (ø)
scanpy/tools/_dpt.py 59.32% <100.00%> (ø)
scanpy/tools/_paga.py 33.33% <ø> (ø)
scanpy/plotting/_baseplot_class.py 89.88% <85.71%> (-0.26%) ⬇️

@flying-sheep flying-sheep merged commit c11b4a2 into master Jan 9, 2024
15 checks passed
@flying-sheep flying-sheep deleted the docs-prose-returns branch January 9, 2024 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant