Skip to content

docs: update VCF module docstrings#448

Merged
jsstevenson merged 4 commits intomainfrom
vcf-docstring
Sep 3, 2024
Merged

docs: update VCF module docstrings#448
jsstevenson merged 4 commits intomainfrom
vcf-docstring

Conversation

@jsstevenson
Copy link
Copy Markdown
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
@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