nitpick, fixing docstrings

bmorris3 · Nov 25, 2022 · 04e0b7c · 04e0b7c
1 parent 110c967
commit 04e0b7c
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -84,3 +84,4 @@

		autosectionlabel_prefix_document = True
		autoclass_content = 'both'
		nitpicky = True