docs: some minor corrections in docstrings

xarray-contrib · Aug 22, 2022 · 75eed31 · 75eed31
1 parent 0f9c32e
commit 75eed31
Show file tree

Hide file tree

Showing 12 changed files with 518 additions and 14 deletions.
diff --git a/docs/auto_examples/2cross/images/sphx_glr_plot_mca_001.png b/docs/auto_examples/2cross/images/sphx_glr_plot_mca_001.png
diff --git a/docs/auto_examples/2cross/plot_mca.ipynb b/docs/auto_examples/2cross/plot_mca.ipynb
@@ -83,6 +83,24 @@
  "singular_vectors = mca.singular_vectors()\npcs = mca.pcs()\nhom_pats, pvals_hom = mca.homogeneous_patterns()\nhet_pats, pvals_het = mca.heterogeneous_patterns()"
  ]
  },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "When two fields are expected, the output of the above methods is a list of\nlength 2, with the first and second entry containing the relevant object for\n``X`` and ``Y``. For example, the p-values obtained from the two-sided t-test\nfor the homogeneous patterns of ``X`` are:\n\n"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {
+ "collapsed": false
+ },
+ "outputs": [],
+ "source": [
+ "pvals_hom[0]"
+ ]
+ },
  {
  "cell_type": "markdown",
  "metadata": {},

diff --git a/docs/auto_examples/2cross/plot_mca.py b/docs/auto_examples/2cross/plot_mca.py
@@ -45,6 +45,14 @@
 hom_pats, pvals_hom = mca.homogeneous_patterns()
 het_pats, pvals_het = mca.heterogeneous_patterns()
 
+#%%
+# When two fields are expected, the output of the above methods is a list of
+# length 2, with the first and second entry containing the relevant object for
+# ``X`` and ``Y``. For example, the p-values obtained from the two-sided t-test
+# for the homogeneous patterns of ``X`` are:
+
+pvals_hom[0]
+
 #%%
 # Create a mask to identifiy where p-values are below 0.05
 

diff --git a/docs/auto_examples/2cross/plot_mca.py.md5 b/docs/auto_examples/2cross/plot_mca.py.md5
@@ -1 +1 @@
-91ab56bff33c723e4b800b87cc9251c7
+99ed52e4350fe1ce0b6e47896a44d3c3