WIP: Documentation cleanup #3575
Conversation
Updated to make a deprecation warning go away. This should not change the behavior at all.
Fix some minor wording errors, but mostly fixed formatting issues.
Minor typo fixes and added MultiTrace attributes section.
The `getting_started.rst` file does not yield output that is linked into the docs. Instead, the index.rst file directly links to the pages once linked from getting_started.
rpgoldman
force-pushed
the
multitrace-doc
branch
from
8e058fc to
56ff5b0
Compare
|
@ColCarroll Please review now -- I have done as much as I can do here in the short term. If you like things you can just merge (feel free to squash merge). If not, LMK, and I will try to fix things up. |
|
Super helpful as always @rpgoldman! |
There was a problem hiding this comment.
Incredible job @rpgoldman!! I just left some minor suggestions on switching markdown inline code to the one used in rst's, but maybe you can ignore them if the recommonmark understands that it is dealing with markdown instead of an reStructuredText.
| @@ -205,7 +205,7 @@ def sample(draws=500, step=None, init='auto', n_init=200000, start=None, trace=N | |||
| ---------- | |||
| draws : int | |||
| The number of samples to draw. Defaults to 500. The number of tuned samples are discarded | |||
| by default. See discard_tuned_samples. | |||
| by default. See `discard_tuned_samples`. | |||
There was a problem hiding this comment.
| by default. See `discard_tuned_samples`. | |
| by default. See ``discard_tuned_samples``. |
| array-like object. For traces with more than one chain the length of each value | ||
| should match the number of total samples already in the trace (chains * iterations), | ||
| array-like objects. For traces with more than one chain the length of each value | ||
| should match the number of total samples already in the trace `(chains * iterations)`, |
There was a problem hiding this comment.
| should match the number of total samples already in the trace `(chains * iterations)`, | |
| should match the number of total samples already in the trace ``(chains * iterations)``, |
| @@ -4060,7 +4060,7 @@ def logcdf(self, value): | |||
| References | |||
| ---------- | |||
| .. [Machler2012] Martin Mächler (2012). | |||
| "Accurately computing log(1-exp(-|a|)) Assessed by the Rmpfr | |||
| "Accurately computing :math: `\log(1-\exp(- \mid a \mid<))` Assessed by the Rmpfr | |||
There was a problem hiding this comment.
| "Accurately computing :math: `\log(1-\exp(- \mid a \mid<))` Assessed by the Rmpfr | |
| "Accurately computing :math:`\log(1-\exp(- \mid a \mid<))` Assessed by the Rmpfr |
|
@lucianopaz Thanks for the corrections. I will make them and push the relevant ones after testing with the documentation generator. |
|
@lucianopaz You are right -- I didn't understand the markdown interaction. Fixing and will push. |
I've been overwhelmed by the number of Sphinx errors and warnings. Here are changes to docstrings and configuration to get rid of a bunch of them.
Still a WIP: I'm going to add a bunch of fixes to RST files, too.