Skip to content

Commit

Permalink
Minor docstring updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
gavinevans committed Oct 25, 2021
1 parent 992072e commit cd1d126
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
9 changes: 2 additions & 7 deletions improver/calibration/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,8 @@
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
"""init for calibration that contains functionality to split forecast and truth
inputs, and functionality to convert a pandas DataFrame in the expected format
into an iris cube.
.. Further information is available in:
.. include:: extended_documentation/calibration/calibration_data_ingestion.rst
"""init for calibration that contains functionality to split forecast, truth
and coefficient inputs.
"""

from collections import OrderedDict
Expand Down
8 changes: 6 additions & 2 deletions improver/calibration/dataframe_utilities.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,12 @@
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
"""
This module defines all the utilities used by the "plugins"
specific for ensemble calibration.
Functionality to convert a pandas DataFrame in the expected format
into an iris cube.
.. Further information is available in:
.. include:: extended_documentation/calibration/calibration_data_ingestion.rst
"""
from typing import Optional, Sequence, Tuple
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
"""
Unit tests for the utilities within the `calibration.utilities`
Unit tests for the utilities within the `calibration.dataframe_utilities`
module.
"""
Expand Down

0 comments on commit cd1d126

Please sign in to comment.