tudat-team / tudat-multidoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Incorrect documentation of load_kernel() spice function on the TudatPy API website

sbcowan opened this issue · comments

I was reading through some of the spice functions looking for load_standard_kernels(). I read the documentation for load_kernel(), which states that the function cleares all loaded kernels, but it should load a specific kernel, I imagine. The documentation is identical to the clear_kernels() function, where the description does fit the function name.

Hi Sean, thanks for pointing this out! @gaffarelj, next time you make an update of the API docs, could you work this fix in as well?

Turns out the docstring was correct in tudat-multidoc, but the clear_kernels() doctrings was incorrectly loaded for the load_kernel() function. Good catch.

I just pushed a fix to this (b5cde5d). We will however have to wait for a little bit before seeing the changes on the API docs website (a new tudat conda package has to be built first to incorporate a new little addition).

I will leave this issue open for now, to close it only when I am certain that this is fixed on the online API website.

I can confirm this is fixed, see here.