Skip to content

Commit 04fb9cc

Browse files
Jorge Fernandez Hernandezbsipocz
authored andcommitted
GAIAPCR-1036 Update documentation for the functions oad_table and load_tables.
1 parent 8ed2536 commit 04fb9cc

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

astroquery/utils/tap/core.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,8 @@ def __internalInit(self):
143143
self.tap_client_id = f"aqtappy1-{VERSION}"
144144

145145
def load_tables(self, *, verbose=False):
146-
"""Loads all public tables
146+
"""Loads all public table metadata. If the user is logged in, it also returns metadata for those tables in the
147+
user's private area.
147148
148149
Parameters
149150
----------
@@ -152,12 +153,13 @@ def load_tables(self, *, verbose=False):
152153
153154
Returns
154155
-------
155-
A list of table objects
156+
A list of TapTableMeta objects
156157
"""
157158
return self.__load_tables(verbose=verbose)
158159

159160
def load_table(self, table, *, verbose=False):
160-
"""Loads the specified table
161+
"""Loads the table metadata, for the specified table. If the user is logged in, the table can refer to a
162+
table in the user's private area.
161163
162164
Parameters
163165
----------
@@ -168,7 +170,7 @@ def load_table(self, table, *, verbose=False):
168170
169171
Returns
170172
-------
171-
A table object
173+
A TapTableMeta object
172174
"""
173175
if table is None:
174176
raise ValueError("Table name is required")

0 commit comments

Comments
 (0)