Add testing for server endpoint coverage in ref docs #383
Conversation
✅ Deploy Preview for neo4j-graph-data-science-client canceled.
|
adamnsch
force-pushed
the
ref-docs-server-ep-coverage-test
branch
from
0c5a143 to
1c2b81b
Compare
adamnsch
force-pushed
the
ref-docs-server-ep-coverage-test
branch
from
1c2b81b to
7cdb00b
Compare
|
|
||
| .. py:function:: gds.kcore.mutate(G: Graph, **config: Any) -> "Series[Any]" | ||
| Computes the k-core values in a network |
There was a problem hiding this comment.
This line is taken directly from the procedure description
| :members: | ||
| :inherited-members: | ||
| :inherited-members: | ||
| :exclude-members: __init__ |
There was a problem hiding this comment.
The class itself already gets the __init__ params documentation, so if we don't exclude __init__ like this they are duplicated
| .. deprecated:: 2.4.0 | ||
| Since GDS server version 2.4.0 you should use the endpoint :func:`gds.graph.sample.rwr` instead. |
There was a problem hiding this comment.
I believe this is correct usage of this sphinx directive. But it does render kind of funny in our custom theme @nvitucci @recrwplay
There was a problem hiding this comment.
Yes. the theme inherits the behaviour from the main docs. When a div has class="deprecated, we use the ::after pseudo-class on a <span> inside the <div> to show a deprecated label. We can modify the css in the Sphinx theme to override this.
There was a problem hiding this comment.
Ah ok :) That sounds good 👍 Is that something you want to do? Or do you need help from us?
The quotes are only needed in the actual Python code. Remove to make more consistent with rest of the docs.
|
The PR looks rather big, but that's just due to a harmless search and replace in the last commit |
doc/sphinx/source/ml.rst
Outdated
| Creates a node regression training pipeline in the pipeline catalog. | ||
|
|
||
| .. py:function:: gds.alpha.scaleProperties.mutate(G: Graph, **config: Any) -> Series[Any] |
There was a problem hiding this comment.
should these be marked with deprecated?
Co-Authored-By: Jacob Sznajdman <breakanalysis@gmail.com>
adamnsch
force-pushed
the
ref-docs-server-ep-coverage-test
branch
from
f7a6064 to
034f2bc
Compare
Previously assumed it would be added twice without this exclusion (neo4j#383 (comment)).
3 participants
Thank you for your contribution to the Graph Data Science Client project.
Before submitting this PR, please read Contributing to the Neo4j Ecosystem.
Make sure: