Add minor fixes to docs (arviz-devs#551)

* Add minor fixes to docs

* Update README with correct docker instructions

README.md

@@ -195,6 +195,10 @@ There is also a Dockerfile which helps for isolating build problems and local de
 3. Run `./scripts/container.sh --build`
 
 This will build a local image with the tag `arviz`. 
-After building the image tests can be executing by running `docker run arviz`.
-An interactive shell can be started by running `docker run -it arviz /bin/bash`. The correct conda environment will be activated automatically.
+After building the image tests can be executing by running  
+`docker run arviz bash pytest arviz/tests`
+
+An interactive shell can be started by running  
+`docker run -it arviz /bin/bash`  
+ The correct conda environment will be activated automatically.
 

arviz/plots/compareplot.py

@@ -14,13 +14,14 @@ def plot_compare(
     plot_kwargs=None,
     ax=None,
 ):
-    """Summary plot for model comparison.
+    """
+    Summary plot for model comparison.
 
     This plot is in the style of the one used in the book Statistical Rethinking (Chapter 6)
     by Richard McElreath.
 
-    Note
-    ----
+    Notes
+    -----
     Defaults to comparing Widely Accepted Information Criterion (WAIC) if present in comp_df column,
     otherwise compares Leave-one-out (loo)
 

doc/api.rst

@@ -52,7 +52,7 @@ Diagnostics
 .. autosummary::
     :toctree: generated/
 
-    effective_n
+    effective_sample_size
     rhat
     geweke