Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix spelling mistakes in documentation and code #7942

Merged
merged 6 commits into from
Oct 23, 2018
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1598,7 +1598,7 @@ astropy.units
astropy.visualization
^^^^^^^^^^^^^^^^^^^^^

- Explicilty default to origin='lower' in WCSAxes. [#7331]
- Explicitly default to origin='lower' in WCSAxes. [#7331]

- Lists of units are now converted in the Matplotlib unit converter. This means
that for Matplotlib versions later than 2.2, more plotting functions now work
Expand Down Expand Up @@ -2372,7 +2372,7 @@ astropy.table
- Removed the deprecated functions ``join``, ``hstack``, ``vstack`` and
``get_groups`` from np_utils. [#5729]

- Added ``name`` paramater to method ``astropy.table.Table.add_column`` and
- Added ``name`` parameter to method ``astropy.table.Table.add_column`` and
``names`` parameter to method ``astropy.table.Table.add_columns``, to
provide the flexibility to add unnamed columns, mixin objects and also to
specify explicit names. Default names will be used if not
Expand Down Expand Up @@ -4234,7 +4234,7 @@ astropy.stats
^^^^^^^^^^^^^

- Added ``sigma_lower`` and ``sigma_upper`` keywords to
``sigma_clip`` to allow for unsymmetric clipping. [#3595]
``sigma_clip`` to allow for non-symmetric clipping. [#3595]

- Added ``cenfunc``, ``stdfunc``, and ``axis`` keywords to
``sigma_clipped_stats``. [#3792]
Expand Down
2 changes: 1 addition & 1 deletion astropy/config/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ class _Conf(config.ConfigNamespace):
element (e.g. 'astropy' if this is 'astropy.config.configuration')
will be used to determine the name of the configuration file, while
the remaining items determine the section. If None, the package will be
inferred from the package within whiich this object's initializer is
inferred from the package within which this object's initializer is
called.

aliases : str, or list of str, optional
Expand Down
4 changes: 2 additions & 2 deletions astropy/convolution/convolve.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ def convolve(array, kernel, boundary='fill', fill_value=0.,
array_internal = np.array(array, dtype=float, copy=False, order='C', subok=True)
except (TypeError, ValueError) as e:
raise TypeError('array should be a Numpy array or something '
'convertable into a float array', e)
'convertible into a float array', e)
array_dtype = getattr(array, 'dtype', array_internal.dtype)


Expand All @@ -208,7 +208,7 @@ def convolve(array, kernel, boundary='fill', fill_value=0.,
kernel_internal = np.array(kernel_internal, dtype=float, copy=True, order='C', subok=False)
except (TypeError, ValueError) as e:
raise TypeError('kernel should be a Numpy array or something '
'convertable into a float array', e)
'convertible into a float array', e)


# Check that the number of dimensions is compatible
Expand Down
4 changes: 2 additions & 2 deletions astropy/convolution/kernels.py
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,7 @@ class MexicanHat1DKernel(Kernel1D):
1D Mexican hat filter kernel.

The Mexican Hat, or inverted Gaussian-Laplace filter, is a
bandpass filter. It smoothes the data and removes slowly varying
bandpass filter. It smooths the data and removes slowly varying
or constant structures (e.g. Background). It is useful for peak or
multi-scale detection.

Expand Down Expand Up @@ -613,7 +613,7 @@ class MexicanHat2DKernel(Kernel2D):
2D Mexican hat filter kernel.

The Mexican Hat, or inverted Gaussian-Laplace filter, is a
bandpass filter. It smoothes the data and removes slowly varying
bandpass filter. It smooths the data and removes slowly varying
or constant structures (e.g. Background). It is useful for peak or
multi-scale detection.

Expand Down
6 changes: 3 additions & 3 deletions astropy/coordinates/baseframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -889,7 +889,7 @@ def replicate(self, copy=False, **kwargs):
Return a replica of the frame, optionally with new frame attributes.

The replica is a new frame object that has the same data as this frame
object and with frame attributes overriden if they are provided as extra
object and with frame attributes overridden if they are provided as extra
keyword arguments to this method. If ``copy`` is set to `True` then a
copy of the internal arrays will be made. Otherwise the replica will
use a reference to the original arrays when possible to save memory. The
Expand Down Expand Up @@ -918,7 +918,7 @@ def replicate_without_data(self, copy=False, **kwargs):
Return a replica without data, optionally with new frame attributes.

The replica is a new frame object without data but with the same frame
attributes as this object, except where overriden by extra keyword
attributes as this object, except where overridden by extra keyword
arguments to this method. The ``copy`` keyword determines if the frame
attributes are truly copied vs being references (which saves memory for
cases where frame attributes are large).
Expand Down Expand Up @@ -1491,7 +1491,7 @@ def separation(self, other):

If the ``other`` coordinate object is in a different frame, it is
first transformed to the frame of this object. This can lead to
unintutive behavior if not accounted for. Particularly of note is
unintuitive behavior if not accounted for. Particularly of note is
that ``self.separation(other)`` and ``other.separation(self)`` may
not give the same answer in this case.

Expand Down
2 changes: 1 addition & 1 deletion astropy/coordinates/builtin_frames/altaz.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
The refraction model is based on that implemented in ERFA, which is fast
but becomes inaccurate for altitudes below about 5 degrees. Near and below
altitudes of 0, it can even give meaningless answers, and in this case
transforming to AltAz and back to another frame can give highly discrepent
transforming to AltAz and back to another frame can give highly discrepant
results. For much better numerical stability, leaving the ``pressure`` at
``0`` (the default), disabling the refraction correction (yielding
"topocentric" horizontal coordinates).
Expand Down
2 changes: 1 addition & 1 deletion astropy/coordinates/representation.py
Original file line number Diff line number Diff line change
Expand Up @@ -2474,7 +2474,7 @@ def from_representation(cls, representation, base=None):


class BaseSphericalCosLatDifferential(BaseDifferential):
"""Differtials from points on a spherical base representation.
"""Differentials from points on a spherical base representation.

With cos(lat) assumed to be included in the longitude differential.
"""
Expand Down
2 changes: 1 addition & 1 deletion astropy/coordinates/sky_coordinate.py
Original file line number Diff line number Diff line change
Expand Up @@ -897,7 +897,7 @@ def separation(self, other):

If the ``other`` coordinate object is in a different frame, it is
first transformed to the frame of this object. This can lead to
unintutive behavior if not accounted for. Particularly of note is
unintuitive behavior if not accounted for. Particularly of note is
that ``self.separation(other)`` and ``other.separation(self)`` may
not give the same answer in this case.

Expand Down
2 changes: 1 addition & 1 deletion astropy/coordinates/tests/test_unit_representation.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
This file tests the behaviour of subclasses of Representation and Frames
This file tests the behavior of subclasses of Representation and Frames
"""

from copy import deepcopy
Expand Down
2 changes: 1 addition & 1 deletion astropy/coordinates/transformations.py
Original file line number Diff line number Diff line change
Expand Up @@ -848,7 +848,7 @@ class FunctionTransformWithFiniteDifference(FunctionTransform):
difference. Both the to and the from frame will be checked for this
attribute, but only one needs to have it. If None, no velocity
component induced from the frame itself will be included - only the
re-orientation of any exsiting differential.
re-orientation of any existing differential.
finite_difference_dt : `~astropy.units.Quantity` or callable
If a quantity, this is the size of the differential used to do the
finite difference. If a callable, should accept
Expand Down
2 changes: 1 addition & 1 deletion astropy/cosmology/funcs.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def z_at_value(func, fval, zmin=1e-8, zmax=1000, ztol=1e-8, maxfun=500):
methods (for example Planck13.distmod) is equal to a known value.

.. warning::
Make sure you understand the behaviour of the function that you
Make sure you understand the behavior of the function that you
are trying to invert! Depending on the cosmology, there may not
be a unique solution. For example, in the standard Lambda CDM
cosmology, there are two redshifts which give an angular
Expand Down
2 changes: 1 addition & 1 deletion astropy/cosmology/tests/test_cosmology.py
Original file line number Diff line number Diff line change
Expand Up @@ -1568,7 +1568,7 @@ def test_z_at_value():
assert allclose(z_at_value(cosmo.distmod, 46 * u.mag),
1.9913891680278133, rtol=1e-6)

# test behaviour when the solution is outside z limits (should
# test behavior when the solution is outside z limits (should
# raise a CosmologyError)
with pytest.raises(core.CosmologyError):
z_at_value(cosmo.angular_diameter_distance, 1500*u.Mpc, zmax=0.5)
Expand Down
4 changes: 2 additions & 2 deletions astropy/extern/configobj/configobj.py
Original file line number Diff line number Diff line change
Expand Up @@ -848,7 +848,7 @@ def walk(self, function, raise_errors=True,
unless ``raise_errors=False``, in which case set the return value to
``False``.

Any unrecognised keyword arguments you pass to walk, will be pased on
Any unrecognized keyword arguments you pass to walk, will be pased on
to the function you pass in.

Note: if ``call_on_sections`` is ``True`` then - on encountering a
Expand Down Expand Up @@ -1208,7 +1208,7 @@ def __init__(self, infile=None, options=None, configspec=None, encoding=None,
# TODO: check the values too.
for entry in options:
if entry not in OPTION_DEFAULTS:
raise TypeError('Unrecognised option "%s".' % entry)
raise TypeError('Unrecognized option "%s".' % entry)
for entry, value in list(OPTION_DEFAULTS.items()):
if entry not in options:
options[entry] = value
Expand Down
2 changes: 1 addition & 1 deletion astropy/io/ascii/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ class DefaultSplitter(BaseSplitter):
escapechar = None
""" one-character stringto quote fields containing special characters """
quoting = csv.QUOTE_MINIMAL
""" control when quotes are recognised by the reader """
""" control when quotes are recognized by the reader """
skipinitialspace = True
""" ignore whitespace immediately following the delimiter """
csv_writer = None
Expand Down
2 changes: 1 addition & 1 deletion astropy/io/ascii/ipac.py
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ class Ipac(basic.Basic):
date Wed Sp 20 09:48:36 1995
key_continue IPAC keywords can continue across lines

Note that there are different conventions for characters occuring below the
Note that there are different conventions for characters occurring below the
position of the ``|`` symbol in IPAC tables. By default, any character
below a ``|`` will be ignored (since this is the current standard),
but if you need to read files that assume characters below the ``|``
Expand Down
2 changes: 1 addition & 1 deletion astropy/io/ascii/tests/test_c_reader.py
Original file line number Diff line number Diff line change
Expand Up @@ -1208,7 +1208,7 @@ def test_fortran_invalid_exp(parallel, guess):

read_values = [col[0] for col in t5.itercols()]
if os.name == 'nt':
# Apparently C strtod() on (some?) MSVC recognises 'd' exponents!
# Apparently C strtod() on (some?) MSVC recognizes 'd' exponents!
assert read_values == vals_v or read_values == vals_e
else:
assert read_values == vals_e
Expand Down
2 changes: 1 addition & 1 deletion astropy/io/fits/hdu/table.py
Original file line number Diff line number Diff line change
Expand Up @@ -1151,7 +1151,7 @@ def load(cls, datafile, cdfile=None, hfile=None, replace=False,
header : Header object
When the cdfile and hfile are missing, use this Header object in
the creation of the new table and HDU. Otherwise this Header
supercedes the keywords from hfile, which is only used to update
supersedes the keywords from hfile, which is only used to update
values not present in this Header, unless ``replace=True`` in which
this Header's values are completely replaced with the values from
hfile.
Expand Down
2 changes: 1 addition & 1 deletion astropy/io/fits/header.py
Original file line number Diff line number Diff line change
Expand Up @@ -1215,7 +1215,7 @@ def extend(self, cards, strip=True, unique=False, update=False,

update : bool, optional
If `True`, update the current header with the values and comments
from duplicate keywords in the input header. This supercedes the
from duplicate keywords in the input header. This supersedes the
``unique`` argument. Commentary keywords are treated the same as
if ``unique=True``.

Expand Down
2 changes: 1 addition & 1 deletion astropy/io/fits/tests/test_fitstime.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ def test_fits_to_time_meta(self, table_types):
t.meta['DATE'] = '1999-01-01T00:00:00'
t.meta['MJD-OBS'] = 56670

# Test for default write behaviour (full precision) and read it
# Test for default write behavior (full precision) and read it
# back using native astropy objects; thus, ensure its round-trip
t.write(self.temp('time.fits'), format='fits', overwrite=True)
tm = table_types.read(self.temp('time.fits'), format='fits',
Expand Down
4 changes: 2 additions & 2 deletions astropy/io/misc/asdf/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Format (ASDF). This subpackage defines classes, referred to as **tags**, that
implement the logic for serialization and deserialization.

ASDF makes use of abstract data type definitons called **schemas**. The tag
ASDF makes use of abstract data type definitions called **schemas**. The tag
classes provided here are specific implementations of particular schemas. Some
of the tags in Astropy (e.g., those related to transforms) implement schemas
that are defined by the ASDF Standard. In other cases, both the tags and
Expand All @@ -18,7 +18,7 @@
package. Users should never need to refer to tag implementations directly.
Their presence should be entirely transparent when processing ASDF files.

If both **asdf** and **astropy** are installed, no futher configuration is
If both **asdf** and **astropy** are installed, no further configuration is
required in order to process ASDF files. The **asdf** package has been designed
to automatically detect the presence of the tags defined by **astropy**.

Expand Down
2 changes: 1 addition & 1 deletion astropy/io/registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def delay_doc_updates(cls):

Notes
-----
Registering mutliple readers and writers can cause significant overhead
Registering multiple readers and writers can cause significant overhead
because the documentation of the corresponding ``read`` and ``write``
methods are build every time.

Expand Down
4 changes: 2 additions & 2 deletions astropy/modeling/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -1412,7 +1412,7 @@ def input_units(self):

Model sub-classes can also use function annotations in evaluate to
indicate valid input units, in which case this property should
not be overriden since it will return the input units based on the
not be overridden since it will return the input units based on the
annotations.
"""
if hasattr(self, '_input_units'):
Expand All @@ -1436,7 +1436,7 @@ def return_units(self):

Model sub-classes can also use function annotations in evaluate to
indicate valid output units, in which case this property should not be
overriden since it will return the return units based on the
overridden since it will return the return units based on the
annotations.
"""
if hasattr(self, '_return_units'):
Expand Down
2 changes: 1 addition & 1 deletion astropy/modeling/fitting.py
Original file line number Diff line number Diff line change
Expand Up @@ -627,7 +627,7 @@ def __call__(self, model, x, y, z=None, weights=None, **kwargs):
"""

# For single models, the data get filtered here at each iteration and
# then passed to the fitter, which is the historical behaviour and
# then passed to the fitter, which is the historical behavior and
# works even for fitters that don't understand masked arrays. For model
# sets, the fitter must be able to filter masked data internally,
# because fitters require a single set of x/y co-ordinates whereas the
Expand Down
16 changes: 8 additions & 8 deletions astropy/modeling/projections.py
Original file line number Diff line number Diff line change
Expand Up @@ -1226,7 +1226,7 @@ class Pix2Sky_ConicPerspective(Pix2SkyProjection, Conic):

See `Conic` for a description of the entire equation.

The projection formulæ are:
The projection formulae are:

.. math::
C &= \sin \theta_a \\
Expand Down Expand Up @@ -1265,7 +1265,7 @@ class Sky2Pix_ConicPerspective(Sky2PixProjection, Conic):

See `Conic` for a description of the entire equation.

The projection formulæ are:
The projection formulae are:

.. math::
C &= \sin \theta_a \\
Expand Down Expand Up @@ -1305,7 +1305,7 @@ class Pix2Sky_ConicEqualArea(Pix2SkyProjection, Conic):

See `Conic` for a description of the entire equation.

The projection formulæ are:
The projection formulae are:

.. math::
C &= \gamma / 2 \\
Expand Down Expand Up @@ -1349,7 +1349,7 @@ class Sky2Pix_ConicEqualArea(Sky2PixProjection, Conic):

See `Conic` for a description of the entire equation.

The projection formulæ are:
The projection formulae are:

.. math::
C &= \gamma / 2 \\
Expand Down Expand Up @@ -1394,7 +1394,7 @@ class Pix2Sky_ConicEquidistant(Pix2SkyProjection, Conic):

See `Conic` for a description of the entire equation.

The projection formulæ are:
The projection formulae are:

.. math::

Expand Down Expand Up @@ -1434,7 +1434,7 @@ class Sky2Pix_ConicEquidistant(Sky2PixProjection, Conic):

See `Conic` for a description of the entire equation.

The projection formulæ are:
The projection formulae are:

.. math::

Expand Down Expand Up @@ -1475,7 +1475,7 @@ class Pix2Sky_ConicOrthomorphic(Pix2SkyProjection, Conic):

See `Conic` for a description of the entire equation.

The projection formulæ are:
The projection formulae are:

.. math::

Expand Down Expand Up @@ -1524,7 +1524,7 @@ class Sky2Pix_ConicOrthomorphic(Sky2PixProjection, Conic):

See `Conic` for a description of the entire equation.

The projection formulæ are:
The projection formulae are:

.. math::

Expand Down
2 changes: 1 addition & 1 deletion astropy/nddata/compat.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class NDDataArray(NDArithmeticMixin, NDSlicingMixin, NDIOMixin, NDData):
WCS-object containing the world coordinate system for the data.

.. warning::
This is not yet defind because the discussion of how best to
This is not yet defined because the discussion of how best to
represent this class's WCS system generically is still under
consideration. For now just leave it as None

Expand Down
4 changes: 2 additions & 2 deletions astropy/nddata/mixins/ndarithmetic.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,13 @@ class NDArithmeticMixin:
:meth:`NDArithmeticMixin.add`. ``None`` means that the result will have no
uncertainty, ``False`` means it takes the uncertainty of the first operand
(if this does not exist from the second operand) as the result's
uncertainty. This behaviour is also explained in the docstring for the
uncertainty. This behavior is also explained in the docstring for the
different arithmetic operations.

Decomposing the units is not attempted, mainly due to the internal mechanics
of `~astropy.units.Quantity`, so the resulting data might have units like
``km/m`` if you divided for example 100km by 5m. So this Mixin has adopted
this behaviour.
this behavior.

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion astropy/nddata/nddata.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ def __init__(self, data, uncertainty=None, mask=None, wcs=None,

# Rather pointless since the NDDataBase does not implement any setting
# but before the NDDataBase did call the uncertainty
# setter. But if anyone wants to alter this behaviour again the call
# setter. But if anyone wants to alter this behavior again the call
# to the superclass NDDataBase should be in here.
super().__init__()

Expand Down
Loading