James/python docstrings #2273
James/python docstrings #2273
Conversation
![github-actions[bot]](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
| /// 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?
| /// 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
| /// Explodes an edge and returns all instances it had been updated as separate edges | ||
| /// | ||
| /// Returns: | ||
| /// Exploded: |
There was a problem hiding this comment.
Should be Edges I believe
| fn explode(&self) -> Self::Exploded; | ||
|
|
||
| /// Returns: | ||
| /// Exploded: |
| /// DateTime: | ||
| fn date_time(&self) -> Self::ValueType<Option<DateTime<Utc>>>; | ||
|
|
||
| /// Gets the layer name for the edge if it is restricted to a single layer |
There was a problem hiding this comment.
Do the below not need return types as well?
| }) | ||
| } | ||
|
|
||
| /// Returns the number of times a change to the history was made. |
There was a problem hiding this comment.
Are these not exposed in python?
| /// | ||
| /// 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: |
| /// Explodes returns an edge object for each update within the original edge. | ||
| /// | ||
| /// Returns: | ||
| /// Exploded: |
There was a problem hiding this comment.
not nodes above or exploded here
What changes were proposed in this pull request?
Further changes required
MetadataViewshould also be exposed.valueshould either be exposed or the documented return type chnaged if there is already a Python equivilent (I was not able to identify one).