Skip to content

Commit 9383656

Browse files
Make sorting documentation more clear
1 parent 4a83b9b commit 9383656

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

docs/usage/viewing-tables.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ without showing the table in the viewer, use :meth:`FireflyClient.fetch_table`:
2222
2323
fc.fetch_table(file_on_server=tval, tbl_id='invisible-table')
2424
25-
Alternatively, you can turn off the `visible` parameter in :meth:`FireflyClient.fetch_table`:
25+
Alternatively, you can turn off the `visible` parameter in :meth:`FireflyClient.show_table`:
2626

2727
.. code-block:: py
2828
@@ -67,3 +67,5 @@ order:
6767
.. code-block:: py
6868
6969
fc.sort_table_column(tbl_id=tbl_id_2mass_psc, column_name='j_m', sort_direction='ASC')
70+
71+
If a column has sorting, it can be removed by specifying `sort_direction=''`.

firefly_client/firefly_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1952,8 +1952,8 @@ def sort_table_column(self, tbl_id, column_name, sort_direction=''):
19521952
column_name : `str`
19531953
Name of the table column to sort
19541954
sort_direction : {'', 'ASC', 'DESC'}, optional
1955-
Direction of sort: '' for unsorted, 'ASC' for ascending, and 'DESC'
1956-
for descending. Default is ''.
1955+
Direction of sort: '' for unsorted (or for removing the sort),
1956+
'ASC' for ascending, and 'DESC' for descending. Default is ''.
19571957
19581958
Returns
19591959
--------

0 commit comments

Comments
 (0)