Conversation
ahms5
requested review from
f-brinkmann,
hoyer-a,
mberz,
sikersten,
tluebeck and
xefonon
f-brinkmann
left a comment
f-brinkmann
left a comment
There was a problem hiding this comment.
We should maybe discuss if spharpy.sphecial should be considered a private module. For example the spherical_harmonics basis methods are barebone wraps of corresponding scipy methods with less documentation than in the SH classes. As far as I understand it, they are used as helpers only and such similar functions defined in multiple places might be confusing.
|
I have removed it for now. maybe in #151 we can add it again, if we see that we will need it. |
This reverts commit c3efe4a.
mberz
left a comment
mberz
left a comment
There was a problem hiding this comment.
I disagree here. If we remove it from the docs people typically do not know about the existence of it. So please re-add it.
github-project-automation
bot
moved this from Open Discussion
to Require review
in Weekly Planning
|
I agree, we should add what we have. should we simply close it and add the ci doc tests with warning i a dedicated pr ? |
|
currently all spharpy modules are in the doc with this pr. ready for review |
f-brinkmann
left a comment
f-brinkmann
left a comment
There was a problem hiding this comment.
Thanks for taking care. I think this would give a good basis for decided on the final structure of the docs at a later point.
docs/api_reference.rst
Outdated
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
There was a problem hiding this comment.
Please do not add blank spaces (if you use the editorconfig plugin it will remove trailing whitespaces automatically ;))
spharpy/spherical.py
Outdated
|
|
||
| This implementation avoids singularities at the poles using identities | ||
| derived in [#]_. | ||
| derived in [#]_ and [#]_. |
There was a problem hiding this comment.
This is incorrect, the singularity avoiding formulation is detailed only in the second reference.
There was a problem hiding this comment.
@mberz I tried to fix it. But I'm not into the topic, if this isnt correct, or you have an better idea, feel free to change here in the PR directly
github-project-automation
bot
moved this from Open Discussion
to Require review
in Weekly Planning
|
ready for review |
hoyer-a
left a comment
hoyer-a
left a comment
There was a problem hiding this comment.
Just one question, otherwise approved.
|
|
||
| .. automodule:: spharpy.special | ||
| :members: | ||
| :special-members: __init__ |
There was a problem hiding this comment.
I'm wondering why this was added, since currently there are no classes inside special
github-project-automation
bot
moved this from Require review
to Reviewer Approved
in Weekly Planning
github-project-automation
bot
moved this from Reviewer Approved
to Done
in Weekly Planning
4 participants
Changes proposed in this pull request:
indexingmodule from docedit 1.6.25:
indexingmodule to docs accroing to @mberz reviewedit 25.7.
indexingandsphericaledit 12.9.
edit 19.9.: