Skip to content

Commit

Permalink
Fix docstring markup errors
Browse files Browse the repository at this point in the history
  • Loading branch information
jdswinbank committed Jun 29, 2020
1 parent 2f224f2 commit 25fb5cb
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 18 deletions.
10 changes: 5 additions & 5 deletions python/lsst/obs/base/butler_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@


class ButlerGetTests(metaclass=abc.ABCMeta):
"""
Tests of obs_* Butler get() functionality.
"""Tests of obs_* Butler get() functionality.
In the subclasses's setUp():
* Call setUp_butler_get() to fill in required parameters.
Expand Down Expand Up @@ -79,7 +78,8 @@ def setUp_butler_get(self,
sky_origin : `tuple` of `float`
Longitude, Latitude of 'raw' exposure
raw_subsets : `tuple` of (kwargs, `int`)
keyword args and expected number of subsets for butler.subset('raw', **kwargs)
keyword args and expected number of subsets for
``butler.subset('raw', **kwargs)``
good_detectorIds : `list` of `int`
list of valid ccd numbers
bad_detectorIds : `list` of `int`
Expand All @@ -89,8 +89,8 @@ def setUp_butler_get(self,
(e.g. lsst.ip.isr.LinearizeLookupTable.LinearityType),
or unittest.SkipTest to skip all linearizer tests.
raw_header_wcs : `lsst.afw.geom.SkyWcs`
The SkyWcs object that should be returned by:
`butler.get("raw_header_wcs", dataId=self.dataIds["raw"])`
The SkyWcs object that should be returned by
``butler.get("raw_header_wcs", dataId=self.dataIds["raw"])``
"""

fields = ['ccdExposureId_bits',
Expand Down
14 changes: 6 additions & 8 deletions python/lsst/obs/base/camera_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@


class CameraTests(metaclass=abc.ABCMeta):
"""
Tests that the butler returns a useable Camera.
"""Tests that the butler returns a useable Camera.
In the subclasses's setUp():
* Call setUp_camera() to fill in required parameters.
Expand All @@ -43,17 +42,16 @@ def setUp_camera(self,
first_detector_name=None,
plate_scale=None,
):
"""
Set up the necessary variables for camera tests.
"""Set up the necessary variables for camera tests.
Parameters
----------
camera_name : `str`
name of this camera
n_detectors : `int`
camera_name : `str`
name of this camera
n_detectors : `int`
number of detectors in this camera
first_detector_name : `str`
first_detector_name : `str`
name of the first detector in this camera
plate_scale : `lsst.geom.Angle`
plate scale at center of focal plane, as angle-on-sky/mm
Expand Down
9 changes: 4 additions & 5 deletions python/lsst/obs/base/tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@

class ObsTests(butler_tests.ButlerGetTests, mapper_tests.MapperTests,
camera_tests.CameraTests):
"""
Aggregator class for all of the obs_* test classes.
"""Aggregator class for all of the obs_* test classes.
Inherit from this class, then lsst.utils.tests.TestCase, in that order.
Expand All @@ -56,8 +55,7 @@ def setUp(self):
"""

def setUp_tests(self, butler, mapper, dataIds):
"""
Set up the necessary shared variables used by multiple tests.
"""Set up the necessary shared variables used by multiple tests.
Parameters
----------
Expand All @@ -73,11 +71,12 @@ def setUp_tests(self, butler, mapper, dataIds):
exposures you do not have/do not want to test. It must contain a
valid 'raw' dataId, in addition to 'bias','flat','dark', which may
be set to SkipTest. For example::
self.dataIds = {'raw': {'visit': 1, 'filter': 'g'},
'bias': {'visit': 1},
'flat': {'visit': 1},
'dark': unittest.SkipTest
}
}
"""
self.butler = butler
self.mapper = mapper
Expand Down

0 comments on commit 25fb5cb

Please sign in to comment.