Skip to content

Commit 75627fb

Browse files
misc missing docstrings
1 parent 48e6743 commit 75627fb

5 files changed

Lines changed: 9 additions & 0 deletions

File tree

raphtory-graphql/src/model/graph/index.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ pub enum AllPropertySpec {
1515
}
1616

1717
#[derive(InputObject)]
18+
/// SomePropertySpec object containing lists of metadata and property names.
1819
pub struct SomePropertySpec {
1920
/// List of metadata.
2021
pub metadata: Vec<String>,

raphtory/src/graph_loader/neo4j_examples.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ fn load_movies(row: Row, graph: &rap::Graph) {
4242
.unwrap();
4343
}
4444

45+
/// Returns the neo4j movie graph example.
4546
pub async fn neo4j_movie_graph(
4647
uri: String,
4748
username: String,

raphtory/src/graph_loader/stable_coins.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ pub struct StableCoin {
2121
value: f64,
2222
}
2323

24+
/// Returns the stablecoin graph example.
2425
pub fn stable_coin_graph(path: Option<String>, subset: bool) -> Graph {
2526
let data_dir = match path {
2627
Some(path) => PathBuf::from(path),

raphtory/src/python/packages/algorithms.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,9 @@ pub fn local_clustering_coefficient(graph: &PyGraphView, v: PyNodeRef) -> Option
308308
}
309309

310310
#[pyfunction]
311+
/// Returns the Local clustering coefficient (batch, intersection) for each specified node in a graph. This measures the degree to which one or multiple nodes in a graph tend to cluster together.
312+
///
313+
/// Uses path-counting for its triangle-counting step.
311314
pub fn local_clustering_coefficient_batch(
312315
graph: &PyGraphView,
313316
v: &Bound<PyAny>,

raphtory/src/python/packages/graph_loader.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ pub fn reddit_hyperlink_graph(timeout_seconds: u64) -> PyResult<Py<PyGraph>> {
7777

7878
#[pyfunction]
7979
#[pyo3(signature = (file_path))]
80+
/// Returns the Reddit hyperlink graph example.
8081
pub fn reddit_hyperlink_graph_local(file_path: &str) -> PyResult<Py<PyGraph>> {
8182
let file_path_buf = PathBuf::from(file_path);
8283
PyGraph::py_from_db_graph(
@@ -86,6 +87,7 @@ pub fn reddit_hyperlink_graph_local(file_path: &str) -> PyResult<Py<PyGraph>> {
8687

8788
#[pyfunction]
8889
#[pyo3(signature = (path=None,subset=None))]
90+
/// Returns the stablecoin graph example.
8991
pub fn stable_coin_graph(path: Option<String>, subset: Option<bool>) -> PyResult<Py<PyGraph>> {
9092
PyGraph::py_from_db_graph(crate::graph_loader::stable_coins::stable_coin_graph(
9193
path,
@@ -95,6 +97,7 @@ pub fn stable_coin_graph(path: Option<String>, subset: Option<bool>) -> PyResult
9597

9698
#[pyfunction]
9799
#[pyo3(signature = (uri,username,password,database="neo4j".to_string()))]
100+
/// Returns the neo4j movie graph example.
98101
pub fn neo4j_movie_graph(
99102
uri: String,
100103
username: String,

0 commit comments

Comments
 (0)