diff --git a/psrqpy/__init__.py b/psrqpy/__init__.py index a6c01c14..56c88646 100644 --- a/psrqpy/__init__.py +++ b/psrqpy/__init__.py @@ -2,7 +2,7 @@ """ A Python tool for interacting with the ATNF pulsar catalogue """ -__version__ = "0.3.4" +__version__ = "0.3.5" from .search import QueryATNF from .pulsar import Pulsar, Pulsars diff --git a/psrqpy/config.py b/psrqpy/config.py index 42a17363..dd210bc3 100644 --- a/psrqpy/config.py +++ b/psrqpy/config.py @@ -20,8 +20,8 @@ #: the full ATNF catalogue query URL QUERY_URL = ATNF_URL + PARAMS_QUERY + USERDEFINED_QUERY + SORT_QUERY + CONDITION_QUERY + PSRNAMES_QUERY + EPHEMERIS_QUERY + QUERY_FLUFF -# pulsar parameters (http://www.atnf.csiro.au/research/pulsar/psrcat/psrcat_help.html) that can be queried -# For each parameter there is a dictionary giving: +# pulsar parameters (http://www.atnf.csiro.au/research/pulsar/psrcat/psrcat_help.html) that can be +# queried. For each parameter there is a dictionary giving: # - 'ref': True if the parameter can have an associated reference in the ATNF catalogue # - 'err': True if the parameter can have an associated error value # - 'unit': a string giving the units for the parameter (to be used if generating an astropy table) diff --git a/psrqpy/pulsar.py b/psrqpy/pulsar.py index 09d1634b..80cbf8c5 100644 --- a/psrqpy/pulsar.py +++ b/psrqpy/pulsar.py @@ -304,7 +304,7 @@ def add_pulsar(self, psr): Args: psr (:class:`~psrqpy.pulsar.Pulsar`, :class:`~psrqpy.pulsar.Pulsars`): a :class:`~psrqpy.pulsar.Pulsar` object, or :class:`~psrqpy.pulsar.Pulsars` - object + object """ assert isinstance(psr, Pulsar) or isinstance(psr, Pulsars), 'psr is not a Pulsar type' diff --git a/psrqpy/search.py b/psrqpy/search.py index 3104a4b3..fbd1bda1 100644 --- a/psrqpy/search.py +++ b/psrqpy/search.py @@ -184,8 +184,7 @@ def generate_query(self, version='', params=None, condition='', sortorder='asc', Args: version (str): a string containing the ATNF version. - params (list, str): a list of `parameters `_ to - query. + params (list, str): a list of `parameters `_ to query. condition (str): the logical `condition `_ string for the query. @@ -196,8 +195,8 @@ def generate_query(self, version='', params=None, condition='', sortorder='asc', a table of parameter values (only works if pulsar names are given) Returns: - str: A string with the content of a :class:`~requests.Response` returned by - :func:`~requests.get` + str: the :attr:`~requests.Response.content` of a :class:`~requests.Response` returned + by :func:`~requests.get` for the ATNF pulsar catalogue query page. """ @@ -457,10 +456,10 @@ def get_pulsars(self): """ Returns: :class:`psrqpy.pulsar.Pulsars`: the queried pulsars returned as a - :class:`~psrqpy.pulsar.Pulsars` object, which is a dictionary of - :class:`~psrqpy.pulsar.Pulsar` objects. If ``JNAME`` or ``NAME`` was not in the - original query, it will be performed again, so that a name is present, which is - required for a :class:`~psrqpy.pulsar.Pulsar` object + :class:`~psrqpy.pulsar.Pulsars` object, which is a dictionary of + :class:`~psrqpy.pulsar.Pulsar` objects. If ``JNAME`` or ``NAME`` was not in the + original query, it will be performed again, so that a name is present, which is + required for a :class:`~psrqpy.pulsar.Pulsar` object """ if not self._pulsars: