commit/galaxy-central: martenson: docs

1 new commit in galaxy-central: https://bitbucket.org/galaxy/galaxy-central/commits/38b88dceb82e/ Changeset: 38b88dceb82e User: martenson Date: 2013-12-21 00:53:41 Summary: docs Affected #: 2 files diff -r 11c30107da4eba80c0e76613d1da223f2af8ffe8 -r 38b88dceb82e092f79c2f4b6aff745d11f77dac4 lib/galaxy/webapps/galaxy/api/histories.py --- a/lib/galaxy/webapps/galaxy/api/histories.py +++ b/lib/galaxy/webapps/galaxy/api/histories.py @@ -64,7 +64,6 @@ @web.expose_api_anonymous def show( self, trans, id, deleted='False', **kwd ): - # oh, sphinx - you bastard """ show( trans, id, deleted='False' ) * GET /api/histories/{id}: diff -r 11c30107da4eba80c0e76613d1da223f2af8ffe8 -r 38b88dceb82e092f79c2f4b6aff745d11f77dac4 lib/galaxy/webapps/galaxy/api/lda_datasets.py --- a/lib/galaxy/webapps/galaxy/api/lda_datasets.py +++ b/lib/galaxy/webapps/galaxy/api/lda_datasets.py @@ -30,15 +30,14 @@ """ show( self, trans, id, **kwd ) * GET /api/libraries/datasets/{encoded_dataset_id}: - Displays information about the dataset identified by the encoded id. + Displays information about the dataset identified by the encoded ID. - + :param id: the encoded id of the dataset to query :type id: an encoded id string - :param id: the encoded id of the dataset to query :rtype: dictionary - :returns: detailed dataset information from - :func:`galaxy.web.base.controller.UsesVisualizationMixin.get_library_dataset.to_dict()` + :returns: detailed dataset information from base controller + .. seealso:: :attr:`galaxy.web.base.controller.UsesLibraryMixinItems.get_library_dataset` """ # Get dataset. try: @@ -66,18 +65,16 @@ """ download( self, trans, format, **kwd ) * GET /api/libraries/datasets/download/{format} + Downloads requested datasets (identified by encoded IDs) in requested format. - .. code-block:: - example: - GET localhost:8080/api/libraries/datasets/download/tbz?ldda_ids%255B%255D=a0d84b45643a2678&ldda_ids%255B%255D=fe38c84dcd46c828 + example: ``GET localhost:8080/api/libraries/datasets/download/tbz?ldda_ids%255B%255D=a0d84b45643a2678&ldda_ids%255B%255D=fe38c84dcd46c828`` + .. note:: supported format values are: 'zip', 'tgz', 'tbz', 'uncompressed' + + :param format: string representing requested archive format :type format: string - :param format: string representing requested archive format - - .. note:: supported formats are: zip, tgz, tbz, uncompressed - + :param lddas[]: an array of encoded ids :type lddas[]: an array - :param lddas[]: an array of encoded ids :rtype: file :returns: either archive with the requested datasets packed inside or a single uncompressed dataset Repository URL: https://bitbucket.org/galaxy/galaxy-central/ -- This is a commit notification from bitbucket.org. You are receiving this because you have the service enabled, addressing the recipient of this email.
participants (1)
-
commits-noreply@bitbucket.org