codecov[bot]
commented
4 years ago Codecov Report
Merging #51 (4091153) into master (ee88a95) will increase coverage by
0.16%. The diff coverage isn/a.
@@ Coverage Diff @@
## master #51 +/- ##
==========================================
+ Coverage 54.14% 54.31% +0.16%
==========================================
Files 7 7
Lines 1773 1773
==========================================
+ Hits 960 963 +3
+ Misses 813 810 -3 | Impacted Files | Coverage Δ | |
|---|---|---|
| pysradb/sraweb.py | 80.61% <0.00%> (+0.61%) |
:arrow_up: |
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing dataPowered by Codecov. Last update ee88a95...4091153. Read the comment docs.
bscrow
saketkc
In this PR I have included my proposed changes to the pysradb documentation.
The new documentation can be viewed at: https://bscrow.github.io/pysradb/
Key changes:
Reworked the index.rst and quickstart.rst files so that it flows more logically.
Included commands.rst to provide a tree of contents of the API pages under /commands
Included the search.rst file, which explains in detail how to use the search feature as a python module and as a command-line tool
Included the extension sphinx-tabs to showcase how to perform the same task (such as retrieving metadata for a given SRP accession number, see quickstart page) on the command line and in python in a (hopefully) clearer manner
Reordered the table of contents tree
This is just my proposal and is open to opinions/modifications =)