Commit 4eaec628 authored by Trent Hare's avatar Trent Hare Committed by Jesse Mapel
Browse files

In support of a domain code review, fix spelling errors 

To support a domain code review, this commit largely addresses minor spelling issues in the code's comments. There are a few exceptions listed below.

- ale\base\type_sensor.py : typo fixed in the code line [181](https://github.com/USGS-Astrogeology/ale/blob/ce3a77cb5fb5749bbc67e0e8bd8a82235cb395c5/ale/base/type_sensor.py#L181)
- ale\drivers\co_drivers.py : apparent value typo in line [75](https://github.com/USGS-Astrogeology/ale/blob/ce3a77cb5fb5749bbc67e0e8bd8a82235cb395c5/ale/drivers/co_drivers.py#L75). please validate update.
- ale\util.py : internal only to the script, the function named "case_sensative" was updated to correct misspelling
- tests\pytests\test_cassini_drivers.py : internal only to the script (and test_util.py), the function named "read_detatched_table" was updated to correct misspelling
- tests\pytests\test_lro_drivers.py : unnecessary semicolon was removed.
- tests\pytests\test_util.py see _test_cassini_drivers.py_ for same update above.
parent 290eefbe

LICENSE.md

+1 −1
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode). 


### No Copyright



The authors have associated their contributions to the ISIS project

The authors have associated their contributions to the ALE project

with this deed, and have dedicated the work to the public domain

by waiving all of their rights to the work worldwide under copyright

law, including all related and neighboring rights, to the extent

README.md

+1 −1
Original line number Diff line number Diff line
@@ -54,7 +54,7 @@ make 
```



Keep in mind that you will need to clone the repository with the `--recursive` flag in order to

retrieve the gtest submodule for testing. If you have already cloned without the `--recusive` flag,

retrieve the gtest submodule for testing. If you have already cloned without the `--recursive` flag,

running the following command will retrieve the gtest submodule manually:

```bash

git submodule update --init --recursive

ale/base/base.py

+4 −4
Original line number Diff line number Diff line
@@ -251,7 +251,7 @@ class Driver(): 
        -------

        : list

          3 element list containing affine transformation coefficient.

          The elements are as follows: constant, x coefficent, y coeffecient

          The elements are as follows: constant, x coefficient, y coefficient

        """

        raise NotImplementedError
@@ -262,7 +262,7 @@ class Driver(): 
        -------

        : list

          3 element list containing affine transformation coefficients.

          The elements are as follows: constant, x coefficent, y coeffecient

          The elements are as follows: constant, x coefficient, y coefficient

        """

        raise NotImplementedError
@@ -272,7 +272,7 @@ class Driver(): 
        Returns

        -------

        : list

          3 element list containing coefficience for the pixels to focal plane

          3 element list containing coefficients for the pixels to focal plane

          transformation. The elements are as follows: constant, sample, line

        """

        raise NotImplementedError
@@ -283,7 +283,7 @@ class Driver(): 
        Returns

        -------

        : : list

          3 element list containing coefficience for the pixels to focal plane

          3 element list containing coefficients for the pixels to focal plane

          transformation. The elements are as follows: constant, sample, line

        """

        raise NotImplementedError

ale/base/data_isis.py

+5 −5
Original line number Diff line number Diff line
@@ -290,7 +290,7 @@ class IsisSpice(): 
        The hex encoded image start time computed from the

        spacecraft clock count

        Expects naif_keywords to be defined. This should be a dict containing

        Naif keyworkds from the label.

        Naif keywords from the label.



        Returns

        -------
@@ -403,7 +403,7 @@ class IsisSpice(): 
        The line component of the affine transformation

        from focal plane coordinates to centered ccd pixels

        Expects naif_keywords to be defined. This should be a dict containing

        Naif keyworkds from the label.

        Naif keywords from the label.

        Expects ikid to be defined. This should be the integer Naif ID code

        for the instrument.
@@ -421,7 +421,7 @@ class IsisSpice(): 
        The sample component of the affine transformation

        from focal plane coordinates to centered ccd pixels

        Expects naif_keywords to be defined. This should be a dict containing

        Naif keyworkds from the label.

        Naif keywords from the label.

        Expects ikid to be defined. This should be the integer Naif ID code

        for the instrument.
@@ -464,7 +464,7 @@ class IsisSpice(): 
        """

        The focal length of the instrument

        Expects naif_keywords to be defined. This should be a dict containing

        Naif keyworkds from the label.

        Naif keywords from the label.

        Expects ikid to be defined. This should be the integer Naif ID code

        for the instrument.
@@ -480,7 +480,7 @@ class IsisSpice(): 
        """

        The triaxial radii of the target body

        Expects naif_keywords to be defined. This should be a dict containing

        Naif keyworkds from the label.

        Naif keywords from the label.



        Returns

        -------

ale/base/data_naif.py

+6 −6
Original line number Diff line number Diff line
@@ -45,7 +45,7 @@ class NaifSpice(): 
           the path to a directory that contains directories whose naming

           convention matches the PDS Kernel Archives format,

           `shortMissionName-versionInfo`. The directory corresponding to the

           driver's mission will be searched for the approriate meta kernel to

           driver's mission will be searched for the appropriate meta kernel to

           load.



        See Also
@@ -78,7 +78,7 @@ class NaifSpice(): 
    @property

    def light_time_correction(self):

        """

        Returns the type of light time correciton and abberation correction to

        Returns the type of light time correction and abberation correction to

        use in NAIF calls. Expects ikid to be defined. This must be the integer

        Naif id code of the instrument.
@@ -147,7 +147,7 @@ class NaifSpice(): 
        Returns

        -------

        : int

          Naif ID used to for indentifying the instrument in Spice kernels

          Naif ID used to for identifying the instrument in Spice kernels

        """

        return spice.bods2c(self.instrument_id)
@@ -169,7 +169,7 @@ class NaifSpice(): 
    def target_id(self):

        """

        Returns the Naif ID code for the target body

        Expects target_name to be defined. This must be a string containig the name

        Expects target_name to be defined. This must be a string containing the name

        of the target body.



        Returns
@@ -317,7 +317,7 @@ class NaifSpice(): 
        Returns a tuple with information detailing the sun position at the time

        of the image. Expects center_ephemeris_time to be defined. This must be

        a floating point number containing the average of the start and end ephemeris time.

        Expects reference frame to be defined. This must be a sring containing the name of

        Expects reference frame to be defined. This must be a string containing the name of

        the target reference frame. Expects target_name to be defined. This must be

        a string containing the name of the target body.
@@ -350,7 +350,7 @@ class NaifSpice(): 
        of the image. Expects ephemeris_time to be defined. This must be a floating point number

        containing the ephemeris time. Expects spacecraft_name to be defined. This must be a

        string containing the name of the spacecraft containing the sensor. Expects

        reference_frame to be defined. This must be a sring containing the name of

        reference_frame to be defined. This must be a string containing the name of

        the target reference frame. Expects target_name to be defined. This must be

        a string containing the name of the target body.