Skip to content

Commit 6564e11

Browse files
Adrian Damianbsipocz
authored andcommitted
Small doc fixes
1 parent 882f293 commit 6564e11

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

astroquery/cadc/core.py

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ def query_name_async(self, name):
291291
292292
Parameters
293293
----------
294-
name: str
294+
name : str
295295
name of object to query for
296296
297297
Returns
@@ -615,11 +615,11 @@ def exec_sync(self, query, maxrec=None, uploads=None, output_file=None,
615615
SQL to execute
616616
maxrec : int
617617
the maximum records to return. defaults to the service default
618-
uploads:
618+
uploads :
619619
Temporary tables to upload and run with the queries
620-
output_file: str or file handler:
620+
output_file : str or file handler
621621
File to save the results to
622-
output_format:
622+
output_format :
623623
Format of the output (default is basic). Must be one
624624
of the formats supported by `astropy.table`
625625
@@ -709,9 +709,9 @@ def run_query(self, query, operation, output_file=None,
709709
when the job is executed in asynchronous mode,
710710
this flag specifies whether the execution will wait until results
711711
are available
712-
upload_resource: str, optional, default None
712+
upload_resource : str, optional, default None
713713
resource to be uploaded to UPLOAD_SCHEMA
714-
upload_table_name: str, required if uploadResource is provided,
714+
upload_table_name : str, required if uploadResource is provided,
715715
default None
716716
resource temporary table name associated to the uploaded resource
717717
@@ -749,13 +749,13 @@ def list_async_jobs(self, phases=None, after=None, last=None,
749749
750750
Parameters
751751
----------
752-
phases: list of str
752+
phases : list of str
753753
Union of job phases to filter the results by.
754-
after: datetime
754+
after : datetime
755755
Return only jobs created after this datetime
756-
last: int
756+
last : int
757757
Return only the most recent number of jobs
758-
short_description: flag - True or False
758+
short_description : flag - True or False
759759
If True, the jobs in the list will contain only the information
760760
corresponding to the TAP ShortJobDescription object (job ID, phase,
761761
run ID, owner ID and creation ID) whereas if False, a separate GET
@@ -811,12 +811,19 @@ def get_access_url(service, capability=None):
811811
"""
812812
Returns the URL corresponding to a service by doing a lookup in the cadc
813813
registry. It returns the access URL corresponding to cookie authentication.
814-
:param service: the service the capability belongs to. It can be identified
815-
by a CADC uri ('ivo://cadc.nrc.ca/) which is looked up in the CADC registry
816-
or by the URL where the service capabilities is found.
817-
:param capability: uri representing the capability for which the access
818-
url is sought
819-
:return: the access url
814+
815+
Parameters
816+
----------
817+
service : str
818+
the service the capability belongs to. It can be identified
819+
by a CADC uri ('ivo://cadc.nrc.ca/) which is looked up in the CADC registry
820+
or by the URL where the service capabilities is found.
821+
capability : str
822+
uri representing the capability for which the access url is sought
823+
824+
Returns
825+
-------
826+
The access url
820827
821828
Note
822829
------

0 commit comments

Comments
 (0)