Skip to content

Commit 6ee98d9

Browse files
committed
Reduce doc warnings
1 parent 612351a commit 6ee98d9

File tree

5 files changed

+12
-6
lines changed

5 files changed

+12
-6
lines changed

cape/cfdx/casedata.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1+
r"""
2+
:mod:`cape.cfdx.casedata`: Single-case data interfaces
3+
=======================================================
14
5+
This module provides the classes :class:`CaseFM` and
6+
:class:`CaseResid` that resid iterative histories of various types.
7+
"""
28

39
# Standard library
410
import os

cape/pylch/databook.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -*- coding: utf-8 -*-
22
r"""
33
:mod:`cape.pylch.databook`: Loci/CHEM data book module
4-
=====================================================
4+
========================================================
55
66
This module provides interfaces to the various CFD outputs tracked by
77
the :mod:`cape` package. These versions are specific to Loci/CHEM.

cape/statutils.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# -*- coding: utf-8 -*-
22
r"""
3+
:mod:`cape.statutils`: Statistics tools
4+
=========================================
5+
36
This module includes several shorthand calls to statistical functions
47
from :mod:`scipy.stats`. The primary tool provided by this module is to
58
calculate 99% (or any other fraction) coverage ranges for two data sets.

doc/api/cape/statutils.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11

2-
:mod:`cape.tnakit.statutils`: Statistics tools
3-
=================================================
4-
5-
.. automodule:: cape.tnakit.statutils
2+
.. automodule:: cape.statutils
63
:members:
74

doc/api/cfdx/casedata.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11

2-
.. automodule:: cape.cfdx.databook
2+
.. automodule:: cape.cfdx.casedata
33
:members:
44

0 commit comments

Comments
 (0)