James/graphql docstrings by jbaross-pometry · Pull Request #2210 · Pometry/Raphtory

jbaross-pometry · 2025-08-05T10:25:18Z

What changes were proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user-facing change? If yes is this documented?

How was this patch tested?

Are there any further changes required?

CLAassistant · 2025-08-05T11:02:45Z

All committers have signed the CLA.

…ames/graphql-docstrings

miratepuffin

As discussed it would be great to rename 'Type' in the docs

If you can find and replace double spaces and ' .' there was quite a few

Not finished going through yet

miratepuffin · 2025-08-13T14:40:15Z

 }
 #[ResolvedObjectFields]
 impl GqlGraphWindowSet {
+    /// Returns the number of items.


Docs for list and count missing throughout here

miratepuffin · 2025-08-13T14:49:17Z

    }
 }

+/// Run the PageRank algorithm


This all needs to be redone once Wyatts PRs are in

miratepuffin · 2025-08-13T14:49:54Z

        .await
    }
-
+    /// Returns the list of metadata schemas for edges connecting these types of nodes


All functions below missing comments

miratepuffin · 2025-08-13T14:52:50Z

 #[derive(Enum)]
 #[graphql(name = "GraphType")]
 pub enum GqlGraphType {
+    /// Persistent.


Worth explainig the difference here

miratepuffin · 2025-08-13T14:54:51Z

        Ok(graph)
    }

+    /// Create vectorised graph in the format used for queries


How does this work if jinja templates etc are not specified on the server/graph

I don't think this creates the vectorisedGraph, just gives access to it

miratepuffin · 2025-08-14T09:32:39Z


 #[ResolvedObjectFields]
 impl QueryRoot {
+    /// Hello world demo


May want to say this is just for ack, checking sever is alive

miratepuffin · 2025-08-14T10:11:17Z

        Namespace::new(data.work_dir.clone(), data.work_dir.clone())
    }
-
+    /// Returns a plugin.


I think you want to clarify here that this returns the the collection of query plugins, not an individual plugin

miratepuffin · 2025-08-14T10:12:01Z

        QueryPlugin::default()
    }
-
+    /// Encodes graph and returns as string


Wanna add the decode is available within the raphtory python/rust client?

miratepuffin · 2025-08-14T10:13:51Z

        Ok(true)
    }

+    /// Creates a new graph.


How can this fail?

miratepuffin · 2025-08-14T10:14:40Z

+    /// Move graph from a path path on the server to a new_path on the server.
+    ///
+    /// If namespace is not provided, it will be set to the current working directory.
+    /// This applies to both the graph namespace and new graph namespace.


I think these namespace comments referr to when we had namespaces and graph names seperate, this no longer makes sense

Also how does this fail?

miratepuffin · 2025-08-14T10:15:00Z

-    // This applies to both the graph namespace and new graph namespace.
+    /// Copy graph from a path path on the server to a new_path on the server.
+    ///
+    /// If namespace is not provided, it will be set to the current working directory.


* Fix/top k (#2228) * add linear top_k implementation * update top_k to use new linear top_k implementation * cleanup * chore: apply tidy-public auto-fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Fix/fastrp (#2229) * update fastrp to properly average embeddings instead of just summing * fix import issue * add helper function to test pairwise distances * cleanup and update python test * chore: apply tidy-public auto-fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * fix docker ci (#2227) * sort ci action and create new Dockerfile for python * add missing dockerfile * remove env from docker ci action * fix python dockerfile * chore: apply tidy-public auto-fixes * add action input to be able to build the python image * add permissions * read base input * fix typo * change default branch to master * chore: apply tidy-public auto-fixes * fix using wrong username on merge step * change manual docker release to also build python * fix digest name conflicts * change choice to boolean for action input * fix digest name using old variable * sort versioning and add nightly action * add permissions to nightly action * add permissions to manual docker release action * read dry-run from the docker action * add dry_run to docker action --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * graphql bench on CI and vector bench (#2198) * rewrite the vector bench script * try disabling available memory setting * try arroy append api * add graphql benchmarks * chore: apply tidy-public auto-fixes * add parallel workflow for graphql bench * chore: apply tidy-public auto-fixes * setup python * setup k6 * chore: apply tidy-public auto-fixes * get output file out of the results folder * add pnpm-workspace.yaml * fix ci error * chore: apply tidy-public auto-fixes * fix ci for good this time? * test gh pages branch * chore: apply tidy-public auto-fixes * test different dir for graphql * reduce target * add -100 for testing * chore: apply tidy-public auto-fixes * add TODO * chore: apply tidy-public auto-fixes * cleanup PR * re-enable base benches * fix flaky bench * remove -100 * remove cell from results.ipynb * sort parent workflow * add missing bench.ts * chore: apply tidy-public auto-fixes * some final bits * print json output on ci to make sure numbers are valid * fix ci * set iteration target to 6400 --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * James/graphql docstrings (#2210) * init * docstrings * docstrings for edges * docstrings for edges * regen schema and docs * run formatting * chore: apply tidy-public auto-fixes * more docstrings * backticks are not used by docs parser so remove * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * more docstrings * update schema and format * chore: apply tidy-public auto-fixes * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * more docstrings * cleanup * more docstrings * chore: apply tidy-public auto-fixes * testcase for inputs * cleanup * chore: apply tidy-public auto-fixes * more docstrings * cleanup * chore: apply tidy-public auto-fixes * more docstrings * cleanup * chore: apply tidy-public auto-fixes * fix page docstrings * cleanup * remove latin * chore: apply tidy-public auto-fixes * initial fixes * fmt * chore: apply tidy-public auto-fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Ben Steer <[email protected]> * Release v0.16.1 (#2236) chore: Release Co-authored-by: Pometry-Team <[email protected]> * Fix explode layers for filtered persistent graph (#2241) * explode layers for valid graph is broken * explode_layers was ignoring layer filters for persistent semantics * chore: apply tidy-public auto-fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * James/graphql docstrings fixes (#2239) * init * docstrings * docstrings for edges * docstrings for edges * regen schema and docs * run formatting * chore: apply tidy-public auto-fixes * more docstrings * backticks are not used by docs parser so remove * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * more docstrings * update schema and format * chore: apply tidy-public auto-fixes * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * chore: apply tidy-public auto-fixes * more docstrings * more docstrings * cleanup * more docstrings * chore: apply tidy-public auto-fixes * testcase for inputs * cleanup * chore: apply tidy-public auto-fixes * more docstrings * cleanup * chore: apply tidy-public auto-fixes * more docstrings * cleanup * chore: apply tidy-public auto-fixes * fix page docstrings * cleanup * remove latin * chore: apply tidy-public auto-fixes * initial fixes * fmt * chore: apply tidy-public auto-fixes * fix double spacing * review fixes * specify layers for has_edge * tidy * chore: apply tidy-public auto-fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Ben Steer <[email protected]> Co-authored-by: Ben Steer <[email protected]> * James/graphql-userguide-16-x (#2233) * update ui image * mutation and views * persistent and event distinction * clean up running steps and add cli * subtitle * proper hierarchy * props and metadata examples * Add troubleshooting * add missing cli parameter * chore: apply tidy-public auto-fixes * add default save location to troubleshooting * markdown formatting * chore: apply tidy-public auto-fixes * chore: apply tidy-public auto-fixes * Clarify docker basics * Clarify docker basics --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Ben Steer <[email protected]> * fix nightly release action (#2244) * fix nightly release action * fix versions missing * chore: apply tidy-public auto-fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * add docker retag action (#2245) * add docker retag action * add permissions * chore: apply tidy-public auto-fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * update Slack invite link (#2252) * test strings in df loaders * Increase sleep time on graphql bench (#2278) Update Makefile * remove polars from parquet and df loading * Bump tracing-subscriber from 0.3.19 to 0.3.20 in the cargo group across 1 directory (#2251) * Bump tracing-subscriber in the cargo group across 1 directory Bumps the cargo group with 1 update in the / directory: [tracing-subscriber](https://github.com/tokio-rs/tracing). Updates `tracing-subscriber` from 0.3.19 to 0.3.20 - [Release notes](https://github.com/tokio-rs/tracing/releases) - [Commits](tokio-rs/tracing@tracing-subscriber-0.3.19...tracing-subscriber-0.3.20) --- updated-dependencies: - dependency-name: tracing-subscriber dependency-version: 0.3.20 dependency-type: direct:production dependency-group: cargo ... Signed-off-by: dependabot[bot] <[email protected]> * chore: apply tidy-public auto-fixes --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Ben Steer <[email protected]> * community detection (#2276) Covers changes for ticket #2268 and adds an introduction to community detection with a tutorial using our existing algorithms and UI. This should apear first in the search results. * initial introduction * add karate example * add karate example * add assets and tests * fix tests * fix tests * fix tests * chore: apply tidy-public auto-fixes * review: simplify node type assignment * chore: apply tidy-public auto-fixes * review: swap to csv file --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Use raphtory from python dir (#2275) * Use raphtory from python dir * comment to match * chore: apply tidy-public auto-fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * add batch_size argument for the low-level functions --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: wyatt-joyner-pometry <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Pedro Rico Pinazo <[email protected]> Co-authored-by: James Baross <[email protected]> Co-authored-by: Ben Steer <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Ben Steer <[email protected]> Co-authored-by: edsherrington <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

jbaross-pometry and others added 7 commits August 1, 2025 16:34

init

2ce8d53

docstrings

8ecccb0

docstrings for edges

42a2416

docstrings for edges

a3086a7

regen schema and docs

b769f02

run formatting

542a62f

chore: apply tidy-public auto-fixes

921d48f

jbaross-pometry and others added 22 commits August 6, 2025 13:46

more docstrings

cb3863f

backticks are not used by docs parser so remove

9022771

more docstrings

269d909

chore: apply tidy-public auto-fixes

f8e7e63

more docstrings

6d961d1

chore: apply tidy-public auto-fixes

c414a8b

Merge branch 'master' into james/graphql-docstrings

6004fe0

more docstrings

19708fb

more docstrings

5a09cbb

update schema and format

f818f89

chore: apply tidy-public auto-fixes

cfbb7ad

more docstrings

16d73d4

Merge remote-tracking branch 'origin/james/graphql-docstrings' into j…

9a19edf

…ames/graphql-docstrings

chore: apply tidy-public auto-fixes

8a727df

more docstrings

f1e50e3

chore: apply tidy-public auto-fixes

c317294

more docstrings

936593d

chore: apply tidy-public auto-fixes

959c30d

more docstrings

fd42f19

Merge remote-tracking branch 'origin/james/graphql-docstrings' into j…

790a1ca

…ames/graphql-docstrings

more docstrings

43349cc

cleanup

2d01e70

jbaross-pometry and others added 18 commits August 8, 2025 16:10

more docstrings

9396c88

chore: apply tidy-public auto-fixes

d4b0590

Merge remote-tracking branch 'origin/james/graphql-docstrings' into j…

c6f99f4

…ames/graphql-docstrings

testcase for inputs

09a54a7

cleanup

4d96f0f

chore: apply tidy-public auto-fixes

dcc7c21

more docstrings

2b93717

cleanup

b3c6ae8

chore: apply tidy-public auto-fixes

f283163

more docstrings

2f2e691

Merge remote-tracking branch 'origin/james/graphql-docstrings' into j…

7f4893f

…ames/graphql-docstrings

cleanup

4dabd89

chore: apply tidy-public auto-fixes

399dc98

fix page docstrings

985c8c8

cleanup

d7e47a2

remove latin

0a5246d

Merge branch 'master' into james/graphql-docstrings

352bc8d

chore: apply tidy-public auto-fixes

b2e5cea

miratepuffin marked this pull request as ready for review August 13, 2025 10:34

miratepuffin reviewed Aug 13, 2025

View reviewed changes

miratepuffin requested changes Aug 14, 2025

View reviewed changes

jbaross-pometry and others added 3 commits August 14, 2025 12:11

initial fixes

a990029

fmt

d5a7d43

chore: apply tidy-public auto-fixes

b18d478

miratepuffin merged commit ceafe28 into master Aug 14, 2025

miratepuffin deleted the james/graphql-docstrings branch August 14, 2025 12:30

jbaross-pometry mentioned this pull request Aug 18, 2025

James/graphql docstrings fixes #2239

Merged

Conversation

jbaross-pometry commented Aug 5, 2025

What changes were proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user-facing change? If yes is this documented?

How was this patch tested?

Are there any further changes required?

Uh oh!

CLAassistant commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

miratepuffin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CLAassistant commented Aug 5, 2025 •

edited

Loading