Typo in documentation of opty

[Peter230655]

In the opty documentation release 1.4.0.dev0 on page 129 it says:
jacobian(free)
Returns.....
Return type
ndarray.shape((2n + q + r + s) * (n(N-1) + o ), )
but in my test it returns
ndarray.shape((2n + q + r + s) * (n(N-1)) + o, ) The bracket to the right of o is moved to the left.
@moorepants confirmed this is a typo.

[moorepants]

The docstring for functions are in the source file right under the associated function signature. The line you mention here in Problem.jacobian() is here: https://github.com/csu-hmc/opty/blob/master/opty/direct_collocation.py#L343

[Peter230655]

I start to see it. (I thought naively that the documentation was some separate document, maybe written in over-leaf or so.)
So, if I want to change this ")" I change it and make a regular PR, right?

[Peter230655]

Question, just to verify, I start to understand how the documentation is generated:

• opty's class Problem inherits from cyipopt.Problem, amongst others the method solve(...). So the description of solve in opty's documentation is taken from the docstrings of that solve in cyipopt.Problem.
• So, in order to change the description of solve on page 132 of the opty documentation (which is not totally consistent with the rest in the documentation, I feel), one would have to somehow change the description in the docstring of cyipopt.Problem.solve(...)

Am I basically on the right track?

[moorepants]

It depends. cyipopt.Problem documentation should stand indedpendent of opty, but if there is an error in cyipopt or you want to expand the general explanations then you edit cyipopt. If it is something opty specific and you want a different docstring in opy for .solve() than the cyipopt.Problem.solve() we can overwrite the cyipopt docstring inside of opty (only).

To overwrite it you do something like:

class Problem(cyipopt.Problem):
    def solve(self, ...):
        """Override docstring""""
        return super().solve(...)

[Peter230655]

In the opty documentation there is this explanation, actually at a few places:

Then, a bit below, solve is explained:

The shape of x given as (n, ) I think is not correct as per the definition of n above.
I am likely not the smartest user of opty, so I cannot really judge whether this should be changed,
@moorepants if you think, it should be changed, I will try as per your suggestion.

[moorepants]

That is a good reason to overwrite the .solve() docstring inside opty (only), as it is correct for cyipopt.

[Peter230655]

I will try it.