-
Notifications
You must be signed in to change notification settings - Fork 311
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
Update docs with new template and documentation #2078
Conversation
akmorrow13
commented
Nov 6, 2018
- switches to default docs template
- adds autosummary documentation for python
Test PASSed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, thanks for doing this! Found a few minor typos
adam-python/bdgenomics/adam/rdd.py
Outdated
def toDF(self): | ||
""" | ||
Converts this GenomicDatset into a dataframeself. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dataframeself → dataframe.
adam-python/bdgenomics/adam/rdd.py
Outdated
|
||
class VariantContextRDD(VCFSupportingGenomicDataset): | ||
""" | ||
Wraps an GenomicDatset with Alignment Context metadata and functions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GenomicDatset → GenomicDataset
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alignment Context → Variant Context
ae0f124
to
b13549b
Compare
Test PASSed. |
@akmorrow13 Ping me when this is ready to merge |
@heuermh I fixed the comments it is ready for merge. I tested locally with sphinx but it is always hard to tell for sure whether readthedocs will run. |
Same here (with sphinx), let's give it a try. |
Thank you, @akmorrow13! |