Skip to content

Commit

Permalink
Fix few typos in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
andy-slac committed Oct 26, 2023
1 parent e599d4e commit 55226d7
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion python/lsst/obs/base/_fitsRawFormatterBase.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ def makeRawSkyWcsFromBoresight(cls, boresight, orientation, detector):
orientation : `lsst.geom.Angle`
The rotation angle of the focal plane on the sky.
detector : `lsst.afw.cameraGeom.Detector`
Where to get the camera geomtry from.
Where to get the camera geometry from.
Returns
-------
Expand Down
18 changes: 9 additions & 9 deletions python/lsst/obs/base/_instrument.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,10 @@ class Instrument(InstrumentBase):
Parameters
----------
collection_prefix : `str`, optional
Prefix for collection names to use instead of the intrument's own name.
This is primarily for use in simulated-data repositories, where the
instrument name may not be necessary and/or sufficient to distinguish
between collections.
Prefix for collection names to use instead of the instrument's own
name. This is primarily for use in simulated-data repositories, where
the instrument name may not be necessary and/or sufficient to
distinguish between collections.
Notes
-----
Expand Down Expand Up @@ -242,7 +242,7 @@ def writeCuratedCalibrations(
calibrations are ingested).
labels : `Sequence` [ `str` ], optional
Extra strings to include in collection names, after concatenating
them with the standard collection name delimeter. If provided,
them with the standard collection name delimiter. If provided,
these are inserted into the names of the `~CollectionType.RUN`
collections that datasets are inserted directly into, as well the
`~CollectionType.CALIBRATION` collection if it is generated
Expand All @@ -254,7 +254,7 @@ def writeCuratedCalibrations(
-----
Expected to be called from subclasses. The base method calls
``writeCameraGeom``, ``writeStandardTextCuratedCalibrations``,
and ``writeAdditionalCuratdCalibrations``.
and ``writeAdditionalCuratedCalibrations``.
"""
# Delegate registration of collections (and creating names for them)
# to other methods so they can be called independently with the same
Expand Down Expand Up @@ -291,7 +291,7 @@ def writeAdditionalCuratedCalibrations(
calibrations are ingested).
labels : `Sequence` [ `str` ], optional
Extra strings to include in collection names, after concatenating
them with the standard collection name delimeter. If provided,
them with the standard collection name delimiter. If provided,
these are inserted into the names of the `~CollectionType.RUN`
collections that datasets are inserted directly into, as well the
`~CollectionType.CALIBRATION` collection if it is generated
Expand Down Expand Up @@ -325,7 +325,7 @@ def writeCameraGeom(
calibrations are ingested).
labels : `Sequence` [ `str` ], optional
Extra strings to include in collection names, after concatenating
them with the standard collection name delimeter. If provided,
them with the standard collection name delimiter. If provided,
these are inserted into the names of the `~CollectionType.RUN`
collections that datasets are inserted directly into, as well the
`~CollectionType.CALIBRATION` collection if it is generated
Expand Down Expand Up @@ -369,7 +369,7 @@ def writeStandardTextCuratedCalibrations(
calibrations are ingested).
labels : `Sequence` [ `str` ], optional
Extra strings to include in collection names, after concatenating
them with the standard collection name delimeter. If provided,
them with the standard collection name delimiter. If provided,
these are inserted into the names of the `~CollectionType.RUN`
collections that datasets are inserted directly into, as well the
`~CollectionType.CALIBRATION` collection if it is generated
Expand Down
4 changes: 2 additions & 2 deletions python/lsst/obs/base/defineVisits.py
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ class DefineVisitsTask(Task):
-----
Each instance of `DefineVisitsTask` reads from / writes to the same Butler.
Each invocation of `DefineVisitsTask.run` processes an independent group of
exposures into one or more new vists, all belonging to the same visit
exposures into one or more new visits, all belonging to the same visit
system and instrument.
The actual work of grouping exposures and computing regions is delegated
Expand All @@ -435,7 +435,7 @@ class DefineVisitsTask(Task):
implementations can be created and configured for instruments for which
these choices are unsuitable (e.g. because visits and exposures are not
one-to-one, or because ``raw.wcs`` datasets for different detectors may not
be consistent with camera geomery).
be consistent with camera geometry).
It is not necessary in general to ingest all raws for an exposure before
defining a visit that includes the exposure; this depends entirely on the
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/obs/base/filters.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ class FilterDefinition:
(e.g. `r` for the SDSS Gunn r-band, which could be on SDSS, LSST, or HSC).
Not all filters have an abstract filter: engineering or test filters may
not have a genericly-termed filter name.
not have a generically-termed filter name.
If specified and if `afw_name` is None, this is used as the
`~lsst.afw.image.Filter` ``name`` field, otherwise it is added to the list
Expand Down
4 changes: 2 additions & 2 deletions python/lsst/obs/base/ingest.py
Original file line number Diff line number Diff line change
Expand Up @@ -1123,7 +1123,7 @@ def ingestFiles(
track_file_attrs : `bool`, optional
Control whether file attributes such as the size or checksum should
be tracked by the datastore. Whether this parameter is honored
depends on the specific datastore implentation.
depends on the specific datastore implementation.
Returns
-------
Expand Down Expand Up @@ -1325,7 +1325,7 @@ def run(
track_file_attrs : `bool`, optional
Control whether file attributes such as the size or checksum should
be tracked by the datastore. Whether this parameter is honored
depends on the specific datastore implentation.
depends on the specific datastore implementation.
Returns
-------
Expand Down
4 changes: 2 additions & 2 deletions python/lsst/obs/base/script/ingestRaws.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,15 @@ def ingestRaws(
Path to a config file that contains overrides to the ingest config.
transfer : `str` or None
The external data transfer type, by default "auto".
processess : `int`
processes : `int`
Number of processes to use for ingest.
ingest_task : `str`
The fully qualified class name of the ingest task to use by default
lsst.obs.base.RawIngestTask.
track_file_attrs : `bool`, optional
Control whether file attributes such as the size or checksum should
be tracked by the datastore. Whether this parameter is honored
depends on the specific datastore implentation.
depends on the specific datastore implementation.
Raises
------
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/obs/base/script/writeCuratedCalibrations.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def writeCuratedCalibrations(repo, instrument, collection, labels):
instrument : `str`
The name or the fully qualified class name of an instrument.
collection : `str` or `None`
The path to the collection that assocaites datasets with validity
The path to the collection that associates datasets with validity
ranges.
Can be `None` in which case the collection name will be determined
automatically.
Expand Down
6 changes: 3 additions & 3 deletions python/lsst/obs/base/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class InitialSkyWcsError(Exception):
def createInitialSkyWcs(visitInfo, detector, flipX=False):
"""Create a SkyWcs from the visit information and detector geometry.
A typical usecase for this is to create the initial WCS for a newly-read
A typical use case for this is to create the initial WCS for a newly-read
raw exposure.
Expand All @@ -52,7 +52,7 @@ def createInitialSkyWcs(visitInfo, detector, flipX=False):
visitInfo : `lsst.afw.image.VisitInfo`
Where to get the telescope boresight and rotator angle from.
detector : `lsst.afw.cameraGeom.Detector`
Where to get the camera geomtry from.
Where to get the camera geometry from.
flipX : `bool`, optional
If False, +X is along W, if True +X is along E.
Expand Down Expand Up @@ -91,7 +91,7 @@ def createInitialSkyWcsFromBoresight(boresight, orientation, detector, flipX=Fal
orientation : `lsst.geom.Angle`
The rotation angle of the focal plane on the sky.
detector : `lsst.afw.cameraGeom.Detector`
Where to get the camera geomtry from.
Where to get the camera geometry from.
flipX : `bool`, optional
If False, +X is along W, if True +X is along E.
Expand Down

0 comments on commit 55226d7

Please sign in to comment.