Skip to content

Commit c4a503d

Browse files
committed
Update docs to indicate string IDs are allowed
1 parent a7d60e3 commit c4a503d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

caar/history.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def create_inside_df(dict_or_pickle_file, thermo_ids=None):
2525
Args:
2626
dict_or_pickle_file (dict or str): The object must have been created with dict_from_file() or pickle_from_file() function.
2727
28-
thermo_ids (Optional[list or other iterable of ints]): Thermostat IDs. If no argument is specified, all IDs from the first arg will be in the DataFrame.
28+
thermo_ids (Optional[list or other iterable of ints or strings]): Thermostat IDs. If no argument is specified, all IDs from the first arg will be in the DataFrame.
2929
3030
Returns:
3131
inside_df (pandas DataFrame): DataFrame has MultiIndex based on the
@@ -47,7 +47,7 @@ def create_cycles_df(dict_or_pickle_file, thermo_ids=None):
4747
Args:
4848
dict_or_pickle_file (dict or str): Must have been created with dict_from_file() or pickle_from_file() function.
4949
50-
thermo_ids (Optional[list or other iterable of ints]): Thermostat IDs. If no argument is specified, all IDs from the first arg will be in the DataFrame.
50+
thermo_ids (Optional[list or other iterable of ints or strings]): Thermostat IDs. If no argument is specified, all IDs from the first arg will be in the DataFrame.
5151
5252
Returns:
5353
cycles_df (pandas DataFrame): DataFrame has MultiIndex based on the ID(s) and timestamps.
@@ -68,7 +68,7 @@ def create_outside_df(dict_or_pickle_file, location_ids=None):
6868
Args:
6969
dict_or_pickle_file (dict or str): Must have been created with dict_from_file() or pickle_from_file() function.
7070
71-
location_ids (Optional[list or other iterable of ints]): Location IDs. If no argument is specified, all IDs from the first arg will be in the DataFrame.
71+
location_ids (Optional[list or other iterable of ints or strings]): Location IDs. If no argument is specified, all IDs from the first arg will be in the DataFrame.
7272
7373
Returns:
7474
outside_df (pandas DataFrame): DataFrame has MultiIndex based on the ID(s) and timestamps.

0 commit comments

Comments
 (0)