Update docstrings

lsst · Aug 24, 2023 · 9e17d3b · 9e17d3b
1 parent 2c8f5ae
commit 9e17d3b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/python/lsst/ap/association/association.py b/python/lsst/ap/association/association.py
@@ -91,7 +91,7 @@ def run(self,
  New DIASources to be associated with existing DIAObjects.
  diaObjects : `pandas.DataFrame`
  Existing diaObjects from the Apdb.
- diffIm : `pandas.DataFrame` optional
+ diffIm : `lsst.afw.image.ExposureF` optional
  Difference image on which the DiaSources were detected.
 
  Returns

diff --git a/python/lsst/ap/association/trailedSourceFilter.py b/python/lsst/ap/association/trailedSourceFilter.py
@@ -41,9 +41,10 @@ class TrailedSourceFilterConfig(pexConfig.Config):
 
 class TrailedSourceFilterTask(pipeBase.Task):
  """Find trailed sources in DIASources. This task checks the length of
- trailLength in the DIASource catalog against using a given
- arcsecond/second rate from maxTrailLength and the exposure time
- to calculate the maximum allowed length before filtering.
+ trailLength in the DIASource catalog using a given
+ arcsecond/second rate from maxTrailLength and the exposure time. The
+ two values are used to calculate the maximum allowed trail length and
+ filters out any trail longer than the maximum.
 
  """
 
@@ -81,7 +82,7 @@ def run(self, dia_sources, diffIm):
  trailedDiaSources=dia_sources[trail_mask].reset_index(drop=True))
 
  def check_dia_source_trail(self, dia_sources, diffIm):
- """Find DiaSources that have trails.
+ """Find DiaSources that have long trails.
 
  Creates a mask for sources with lengths greater than 0.416
  arcseconds/second multiplied by the exposure time.