Fix math rendering in docstrings by natashawatkins · Pull Request #315 · QuantEcon/QuantEcon.py

natashawatkins · 2017-07-04T05:19:58Z

Sorry about such a large commit (did not expect to fix this much)

A lot of math renderings weren't working either due to:

no use of .. math::
not using raw string
not using '\' for symbols
matrices formatted incorrectly

Also

ivp.py's class docstring was placed incorrectly
I deleted some whitespaces and cleaned up some code/comments
there were a couple of errors(?) related to matrix conformability
fixed a compilation warning message from approximation.py

Best way to review is probably to make html in quantecon/docs

coveralls · 2017-07-04T05:27:21Z

Coverage remained the same at 92.124% when pulling b4c167f on math-rendering into c60251d on master.

coveralls · 2017-07-04T05:34:52Z

Coverage remained the same at 92.124% when pulling 9a07268 on math-rendering into c60251d on master.

mmcky · 2017-07-04T06:13:27Z

I have added this branch to rtd for review: http://quanteconpy.readthedocs.io/en/math-rendering/

natashawatkins · 2017-07-04T06:28:50Z

Thanks!

…

On 4 Jul 2017, at 4:13 pm, mmcky ***@***.***> wrote: I have added this branch to rtd for review -- it is currently building. https://readthedocs.org/projects/quanteconpy/builds/5642386/ ― You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

mmcky

@natashawatkins this is really nice work! I had a few comments for you from my brief review. rtd is also setup for review of this branch now.

mmcky · 2017-07-04T06:22:59Z

        """
-        Computes the limit of Sigma_t as t  goes to infinity by
-        solving the associated Riccati equation.  Computation is via the
+        Computes the limit of :math:`\Sigma_t` as t goes to infinity by


should t be inline math?

I'm not sure about this - it could be? But maybe unnecessary?

mmcky · 2017-07-04T06:24:53Z

        P : array_like(float)
            P is part of the value function representation of
-            V(x) = xPx + d
+            :math:`V(x) = x'Px + d`


good catch with x'

mmcky · 2017-07-04T06:25:39Z

+
+    given :math:`x_0` = x0
+
+    Here :math:`x_t` and :math:`v_t` are both n x 1 and A is n x n.


should A be inline math?

Fixed thanks

mmcky · 2017-07-04T06:28:47Z

-    y_t = \bar{y} + \rho y_{t-1} + \varepsilon_t
-    where \varepsilon_t is i.i.d. normal of mean 0, std dev of sigma
+    :math:`y_t = \bar{y} + \rho y_{t-1} + \varepsilon_t`
+    where :math:`\varepsilon_t` is i.i.d. normal of mean 0, std dev of sigma


what is the difference between \varepsilon and \epsilon?

Apparently they look slightly different but represent the same symbol - https://tex.stackexchange.com/questions/304534/what-does-the-var-prefix-stand-for-in-varphi-and-varepsilon-etc

mmcky · 2017-07-04T06:30:04Z


-    using Tauchen's method.  Here {u_t} is an iid Gaussian process with zero
-    mean.
+    using Tauchen's method. Here :math:`{u_t}`` is an iid Gaussian process


should this have two end ticks?

Fixed thanks

mmcky · 2017-07-04T06:30:38Z

    Note that SciPy also has a discrete riccati equation solver.  However it
-    cannot handle the case where R is not invertible, or when N is nonzero.
-    Both of these cases can be handled in the algorithm implemented below.
+    cannot handle the case where :math:`R` is not invertible, or when N is


should N be inline math?

Fixed thanks

jstac · 2017-07-04T17:00:44Z

@natashawatkins Thanks! Great work. I have checked all details but it's a big step forward even if some errors remain.

@mmcky Is the maintainer of the package so I'll leave the merge up to him.

coveralls · 2017-07-04T17:29:48Z

Coverage remained the same at 92.124% when pulling 90a77a8 on math-rendering into c60251d on master.

coveralls · 2017-07-04T17:33:08Z

Coverage remained the same at 92.124% when pulling 90a77a8 on math-rendering into c60251d on master.

mmcky · 2017-07-04T23:25:36Z

Thanks @natashawatkins.

natashawatkins · 2017-07-04T17:32:26Z

+    Here :math:`x` is n x 1, :math:`u` is k x 1, :math:`w` is j x 1 and the 
+    matrices are conformable for these dimensions.  The sequence :math:`{w_t}`
+    is assumed to be white noise, with zero mean and
+    :math:`\mathbb{E} [ w_t' w_t ] = I`, the j x j identity.


@mmcky I think w_t w_t is also not conformable? Could you check please? Thanks

Sorry I forgot to click submit review

natashawatkins added 12 commits July 4, 2017 13:45

add math rendering and clean up lss.py

5ea6ba7

add math rendering and clean up kalman.py

8866618

fix error and math rendering in approximation.py

2ad262a

move class docstring outside init in ivp.py

f5003f3

fix math rendering and some documentation errors in lqcontrol.py

be085e7

fix math rendering and clean up matrix.eqn.py

bb78685

fix math rendering and clean up robustlq.py

803aaa2

fix math rendering in quadsums.py

4f69c81

fix math rendering and clean up code in estspec.py

56adbda

fix math rendering in arma.py

56c7c7a

fix math rendering in lae.py

86476b2

fix previous commit

b4c167f

natashawatkins requested review from jstac and mmcky July 4, 2017 05:19

natashawatkins changed the title ~~Math rendering~~ Fix math rendering Jul 4, 2017

natashawatkins changed the title ~~Fix math rendering~~ Fix math rendering in docstrings Jul 4, 2017

fix brackets in lss.py

9a07268

mmcky requested changes Jul 4, 2017

View reviewed changes

natashawatkins added 4 commits July 5, 2017 03:11

fix to approximation.py

9fa26d9

Fix to matrix_eqn.py docstring

e3a3a55

Fixes to lss.py

5aeaa19

Update links in docs

90a77a8

mmcky approved these changes Jul 4, 2017

View reviewed changes

mmcky merged commit a82ba69 into master Jul 4, 2017

mmcky deleted the math-rendering branch July 4, 2017 23:25

natashawatkins commented Jul 4, 2017

View reviewed changes

oyamad mentioned this pull request Jul 5, 2017

Fix doc warning #312

Closed

1 task


		given :math:`x_0` = x0

		Here :math:`x_t` and :math:`v_t` are both n x 1 and A is n x n.

Uh oh!

Conversation

natashawatkins commented Jul 4, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Jul 4, 2017

Uh oh!

coveralls commented Jul 4, 2017

Uh oh!

mmcky commented Jul 4, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

natashawatkins commented Jul 4, 2017 via email

Uh oh!

mmcky left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jstac commented Jul 4, 2017

Uh oh!

coveralls commented Jul 4, 2017

Uh oh!

coveralls commented Jul 4, 2017

Uh oh!

mmcky commented Jul 4, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

natashawatkins commented Jul 4, 2017 •

edited

Loading

mmcky commented Jul 4, 2017 •

edited

Loading