Skip to content
This repository has been archived by the owner on Jan 24, 2018. It is now read-only.

Commit

Permalink
Merge pull request #1269 from jeromekelleher/1252-quickfix
Browse files Browse the repository at this point in the history
Removed misleading type documentation.
  • Loading branch information
kozbo authored Jun 23, 2016
2 parents d700b9c + 2648066 commit 32d5e3c
Showing 1 changed file with 3 additions and 64 deletions.
67 changes: 3 additions & 64 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ library are defined by the

.. warning:: This client API should be considered early alpha quality,
and may change in arbitrary ways. In particular, the current
camelCase convention for identifiers may change to snake_case
in future.
camelCase convention for identifiers is scheduled to change
in the near future.

.. todo:: A full description of this API and links to a tutorial on how
to use it, as well as a quickstart showing the basic usage.
Expand All @@ -23,68 +23,7 @@ library are defined by the
Types
-----

.. todo:: A short overview of the types and links to the high-level
docs.

++++++++++
References
++++++++++

.. autoclass:: ga4gh.protocol.ReferenceSet
:members:

.. autoclass:: ga4gh.protocol.Reference
:members:


++++++++
Datasets
++++++++

.. autoclass:: ga4gh.protocol.Dataset
:members:

++++++++
Variants
++++++++

.. autoclass:: ga4gh.protocol.VariantSet
:members:

.. autoclass:: ga4gh.protocol.CallSet
:members:

.. autoclass:: ga4gh.protocol.Variant
:members:

++++++++++++++++++++++++
Variant Annotation
++++++++++++++++++++++++

.. autoclass:: ga4gh.protocol.VariantAnnotationSet
:members:

.. autoclass:: ga4gh.protocol.VariantAnnotation
:members:

.. autoclass:: ga4gh.protocol.TranscriptEffect
:members:

+++++
Reads
+++++

.. autoclass:: ga4gh.protocol.ReadGroupSet
:members:

.. autoclass:: ga4gh.protocol.ReadGroup
:members:

.. autoclass:: ga4gh.protocol.ReadAlignment
:members:

.. autoclass:: ga4gh.protocol.Position
:members:
.. todo:: Add links to the upstream documentation for the GA4GH types.

----------
Client API
Expand Down

0 comments on commit 32d5e3c

Please sign in to comment.