Skip to content

Commit 269509d

Browse files
committed
comment on capitalization
1 parent 63a573e commit 269509d

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

astroquery/heasarc/core.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,12 @@ def _args_to_payload(self, **kwargs):
297297
action : str, optional
298298
Type of action to be taken (defaults to 'Query')
299299
"""
300-
# Define the basic query for this object
300+
# All user-facing parameters are lower case, for consistency and to preserve current interface.
301+
# The parameters as passed to the HEASARC service are capitalized according to the HEASARC requirements.
302+
# It means that in some cases, unfortunately, this module will identical but differently capitalized, e.g. `Entry` vs `entry`.
303+
# All transformations to the HEASARC-specific capitalization is done in this `_args_to_payload` function.
304+
305+
# Define the basic query for this object
301306

302307
mission = kwargs.pop('mission')
303308

0 commit comments

Comments
 (0)