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

Grammar fixes in sc.tl docstrings #3438

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Grammar fixes in sc.tl docstrings #3438

merged 3 commits into from
Jan 15, 2025

Conversation

zm711
Copy link
Contributor

@zm711 zm711 commented Jan 14, 2025

Been working with scanpy for a bit now and really appreciate all the work you're all doing. Noticed a few grammar mistakes in docstrings. If it's helpful I figured I could submit a couple PRs to fix up docstrings :) . As a demonstration this is just a quick rundown of the tools submodule. If this isn't desired just let me know.

  • Closes # NA
  • Tests included or not required because: I was just updating some docstrings to be slightly more idiomatic English so no api or meaning changes.
  • Release notes not necessary because: Same as above. Meaning not changed for anything. Just grammar fixes. Although if you want something here let me know.

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.36%. Comparing base (f7acd02) to head (be4b087).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3438   +/-   ##
=======================================
  Coverage   75.36%   75.36%           
=======================================
  Files         112      112           
  Lines       13219    13219           
=======================================
  Hits         9963     9963           
  Misses       3256     3256           
Files with missing lines Coverage Δ
src/scanpy/tools/_dendrogram.py 83.33% <ø> (ø)
src/scanpy/tools/_diffmap.py 76.47% <ø> (ø)
src/scanpy/tools/_dpt.py 58.79% <ø> (ø)
src/scanpy/tools/_draw_graph.py 63.93% <ø> (ø)
src/scanpy/tools/_embedding_density.py 63.49% <ø> (ø)
src/scanpy/tools/_ingest.py 75.65% <ø> (ø)
src/scanpy/tools/_leiden.py 88.73% <ø> (ø)
src/scanpy/tools/_louvain.py 61.22% <ø> (ø)
src/scanpy/tools/_marker_gene_overlap.py 72.00% <ø> (ø)
src/scanpy/tools/_score_genes.py 86.66% <ø> (ø)
... and 3 more

Copy link
Member

@Zethson Zethson left a comment

Choose a reason for hiding this comment

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

Great! Please keep the docstring improvements and fixes coming. A few minor points. I am not a native speaker and am happy to be convinced that my comments are not valid.

src/scanpy/tools/_dendrogram.py Outdated Show resolved Hide resolved
src/scanpy/tools/_dendrogram.py Outdated Show resolved Hide resolved
src/scanpy/tools/_draw_graph.py Show resolved Hide resolved
@Zethson Zethson added this to the 1.11.0 milestone Jan 15, 2025
@Zethson
Copy link
Member

Zethson commented Jan 15, 2025

Feel free to add a release note if you want this PR to be mentioned in the next release. Docstring improvements are important.

@zm711
Copy link
Contributor Author

zm711 commented Jan 15, 2025

Feel free to add a release note if you want this PR to be mentioned in the next release. Docstring improvements are important.

Since I have a few modules to go maybe I could add a release note after I finish a few others (unless the release is super soon ). Then it would be something like docstring fixes (pr x pr x pr x). That seems cleaner to me.

@Zethson
Copy link
Member

Zethson commented Jan 15, 2025

Sure, fine with me. We can group them later.

@Zethson Zethson enabled auto-merge (squash) January 15, 2025 10:52
@Zethson Zethson merged commit fa38823 into scverse:main Jan 15, 2025
13 of 14 checks passed
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.

2 participants