Conversation
![github-actions[bot]](proxy.php?url=https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
⚠️ Performance Alert ⚠️
Possible performance regression was detected for benchmark 'GraphQL Benchmark'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 2.
| Benchmark suite | Current: 59feaed | Previous: f14de7d | Ratio |
|---|---|---|---|
addNode |
20 req/s |
1460 req/s |
73 |
This comment was automatically generated by workflow using github-action-benchmark.
| Returns the source node of the edge. | ||
|
|
||
| Returns: | ||
| GqlNode: |
There was a problem hiding this comment.
Think this should be Node
| /// Min result. | ||
| /// | ||
| /// Returns: | ||
| /// value: |
There was a problem hiding this comment.
This would be a Proptype i.e. if the property is a float it would be a float
There was a problem hiding this comment.
ok and what can we do about that?
| /// Returns the source node of the edge. | ||
| /// | ||
| /// Returns: | ||
| /// Nodes: |
There was a problem hiding this comment.
This is a bit unfortunte as for Edge this is a Node and for Edges this is a PathFrom I believe?
There was a problem hiding this comment.
this doesn't produce an error when stating 'Nodes' and we don't have a way to handle these multiple definitions. I can write some advice about that in the docstring but i need to know what the actual behaviour is to do that so some more detailed explanation would be helpful
| /// Returns the id of the edge. | ||
| /// | ||
| /// Returns: | ||
| /// GID: |
There was a problem hiding this comment.
I don't know what a GID pair is, in python GID exists https://raphtory--2273.org.readthedocs.build/en/2273/reference/python/raphtory/Modules/typing/#raphtory.typing.GID
There was a problem hiding this comment.
As in it is a tuple [GID,GID] not a singular GID
| /// | ||
| /// Returns: | ||
| /// DegreeView: a view of the undirected node degrees | ||
| /// DegreeView: a view of the undirected node degrees. |
There was a problem hiding this comment.
Will all of these Nodestates we are going to want to say these return a nodestate
| /// | ||
| /// Returns: | ||
| /// DataFrame: the view of the node data as a pandas Dataframe | ||
| /// DataFrame: the view of the node data as a pandas Dataframe. |
There was a problem hiding this comment.
does this need to be pandas.dataframe
| /// Parameters: | ||
| /// file_path: (str) | ||
| /// | ||
| /// Returns: |
| /// path: (str) | ||
| /// subset: (bool) | ||
| /// | ||
| /// Returns: |
…mes/python-docstrings
…mes/python-docstrings
2 participants
What changes were proposed in this pull request?
Outstanding stubs-gen errors
Some additional types, such as
MetadataViewshould also be exposed.The new itterables need documenting, I have not been able to identify where this should be done.
For operators a lot of the python return types are unclear, this includes many of the entries that were previously 'value'