From 04e0b7c25ceb07c549fa74fa2674d49657d0e3a2 Mon Sep 17 00:00:00 2001 From: "Brett M. Morris" Date: Fri, 25 Nov 2022 12:46:03 -0500 Subject: [PATCH] nitpick, fixing docstrings --- docs/conf.py | 1 + tynt/core.py | 4 ++-- tynt/download.py | 4 ++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4fbd5a2..e5a7e51 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -84,3 +84,4 @@ autosectionlabel_prefix_document = True autoclass_content = 'both' +nitpicky = True diff --git a/tynt/core.py b/tynt/core.py index f461de6..0d5a7f7 100644 --- a/tynt/core.py +++ b/tynt/core.py @@ -21,7 +21,7 @@ def __init__(self, path=None): """ Parameters ---------- - path : str (optional) + path : str Path to ``fft.fits`` file. If None, uses the package default data path. """ if path is None: @@ -186,7 +186,7 @@ def __init__(self, wavelength, transmittance, model=None): """ Parameters ---------- - wavelength : ~astropy.unit.Quantity + wavelength : ~astropy.units.Quantity Wavelength array transmittance : ~numpy.ndarray Transmittance array diff --git a/tynt/download.py b/tynt/download.py index ba5307d..d091b9a 100644 --- a/tynt/download.py +++ b/tynt/download.py @@ -62,7 +62,7 @@ def download_all_links(self, cache=True): Parameters ---------- - cache : bool, optional + cache : bool Cache the links to your local astropy cache. """ filters = [] @@ -93,7 +93,7 @@ def download_all_tables(self, cache=True): Parameters ---------- - cache : bool, optional + cache : bool Cache the links to your local astropy cache. """ if self.links is None: