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.

Sign up for GitHub

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

Jump to bottom

docs: update VCF module docstrings #448

Merged
merged 4 commits into from
Sep 3, 2024
Merged

docs: update VCF module docstrings #448

merged 4 commits into from
Sep 3, 2024

Conversation

jsstevenson
Copy link
Contributor

@jsstevenson jsstevenson commented Aug 30, 2024 •
edited
Loading

  • remove type annotations from docstrings -- modern sphinx tooling can grab them from the function signature
  • clean up wording and add additional clarity for some public method args/descriptions

@jsstevenson jsstevenson marked this pull request as ready for review September 3, 2024 17:20
@jsstevenson jsstevenson requested review from a team as code owners September 3, 2024 17:20
@jsstevenson jsstevenson changed the title docs: update VCF module docstring type annotations docs: update VCF module docstrings Sep 3, 2024
@jsstevenson jsstevenson merged commit 0eaee2b into main Sep 3, 2024
6 checks passed
@jsstevenson jsstevenson deleted the vcf-docstring branch September 3, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@korikuzma korikuzma korikuzma approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jsstevenson @korikuzma