Skip to content

Commit

Permalink
docs: Freetext does not expect a tuple of strings, but multiple strin…
Browse files Browse the repository at this point in the history
…g arguments
  • Loading branch information
ManonMarchand committed Jul 12, 2024
1 parent 78dff31 commit b4def66
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion pyvo/registry/rtcons.py
Original file line number Diff line number Diff line change
Expand Up @@ -251,11 +251,16 @@ def __init__(self, *words: str):
Parameters
----------
*words : tuple of str
*words : str
It is recommended to pass multiple words in multiple strings
arguments. You can pass in phrases (i.e., multiple words
separated by space), but behaviour might then vary quite
significantly between different registries.
Examples
--------
>>> from pyvo import registry
>>> registry.Freetext("Gamma", "Ray", "Burst") # doctest: +IGNORE_OUTPUT
"""
self.words = words

Expand Down

0 comments on commit b4def66

Please sign in to comment.