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

Add VCF module to docs and fixup docs warnings #78

Merged
merged 3 commits into from
Nov 28, 2023
Merged

Conversation

clintval
Copy link
Member

Closes #72

Also fixes up all these warnings:

fgpyo/sam/builder.py:docstring of fgpyo.sam.builder.SamBuilder.add_pair:8: WARNING: Unexpected indentation.
fgpyo/sam/builder.py:docstring of fgpyo.sam.builder.SamBuilder.add_pair:9: WARNING: Bullet list ends without a blank line; unexpected unindent.
fgpyo/sam/builder.py:docstring of fgpyo.sam.builder.SamBuilder.add_pair:15: WARNING: Unexpected indentation.
fgpyo/sam/clipping.py:docstring of fgpyo.sam.clipping.ClippingInfo.query_bases_clipped:1: WARNING: duplicate object description of fgpyo.sam.clipping.ClippingInfo.query_bases_clipped, other instance in api, use :noindex: for one of them
fgpyo/sam/clipping.py:docstring of fgpyo.sam.clipping.ClippingInfo.ref_bases_clipped:1: WARNING: duplicate object description of fgpyo.sam.clipping.ClippingInfo.ref_bases_clipped, other instance in api, use :noindex: for one of them
fgpyo/fasta/builder.py:docstring of fgpyo.fasta.builder:11: WARNING: Unexpected indentation.
fgpyo/fasta/builder.py:docstring of fgpyo.fasta.builder:16: WARNING: Block quote ends without a blank line; unexpected unindent.
fgpyo/io/__init__.py:docstring of fgpyo.io.to_writer:9: WARNING: Block quote ends without a blank line; unexpected unindent.
fgpyo/util/inspect.py:docstring of fgpyo.util.inspect.attr_from:1: WARNING: duplicate object description of fgpyo.util.inspect.attr_from, other instance in api, use :noindex: for one of them

Copy link

codecov bot commented Nov 25, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (66b2200) 92.88% compared to head (b0f9ba7) 92.91%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #78      +/-   ##
==========================================
+ Coverage   92.88%   92.91%   +0.02%     
==========================================
  Files          30       30              
  Lines        3122     3134      +12     
  Branches      581      581              
==========================================
+ Hits         2900     2912      +12     
  Misses        148      148              
  Partials       74       74              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@nh13 nh13 left a comment

Choose a reason for hiding this comment

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

Thank-you for this! I've made a pre-built version here: https://fgpyo.readthedocs.io/en/cv_docs_fixup/

@clintval
Copy link
Member Author

@nh13 I found a few more docs issues and pushed up a commit. I know there are still more rough edges, but perhaps we should merge this and I can make smaller docs PRs as I come across issues going forward.

@clintval clintval requested a review from nh13 November 28, 2023 19:01
Copy link
Member

@nh13 nh13 left a comment

Choose a reason for hiding this comment

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

lgtm, thank-you!

@clintval clintval merged commit fb03634 into main Nov 28, 2023
6 checks passed
@clintval clintval deleted the cv_docs_fixup branch November 28, 2023 21:11
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.

Recent VCF work is not available in the public docs
2 participants