Skip to content

James/graphql docstrings fixes - #2239

Merged
miratepuffin merged 57 commits into
masterfrom
james/graphql-docstrings-fixes
Aug 22, 2025
Merged

James/graphql docstrings fixes#2239
miratepuffin merged 57 commits into
masterfrom
james/graphql-docstrings-fixes

Conversation

@jbaross-pometry

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

  • Fixes for docstrings
  • Removal of extra whitespace

Are there any further changes required?

Unresolved issues

#2210

  • raphtory-graphql/src/model/graph/edges.rs line 179: Probably requires a bit more detail as copy and paste from Edge
  • raphtory-graphql/src/model/graph/filtering.rs : Wanna add more on what a valid state is
  • raphtory-graphql/src/model/graph/filtering.rs line 29: Probably for all of these collections we want some standard string that explains what they are doing.
  • raphtory-graphql/src/model/graph/filtering.rs : Node, Edge, and Type filters
  • raphtory-graphql/src/model/graph/filtering.rs line 275: May want to clarify the different between isIn and contains?
  • raphtory-graphql/src/model/graph/filtering.rs line 312: Maybe a little note here on the difference between a property filter and temporal property filter
  • raphtory-graphql/src/model/graph/filtering.rs line 451: Some details here on what the difference is?
  • raphtory-graphql/src/model/graph/graph.rs line: 123: quick comment on what valid edges are
    • As above I'm not 100% confident in my understanding of 'valid' so could do with a pointer
  • raphtory-graphql/src/model/graph/graph.rs : Seems to be some functions below like apply_views that are missing docs
    • This is true apply_views and some list and count functions do not have descriptions because I do not know what they would be.
    • Also true for raphtory-graphql/src/model/graph/node.rs
  • raphtory-graphql/src/model/graph/mod.rs : I think you need to specify here some duration examples "1 day" "2 months and 3 hours" etc and that epoch is raw increment or something
    • An exahustive list of options would be good if you can get me one
  • raphtory-graphql/src/model/graph/property.rs line 52: We need to change this into an acutal map
  • raphtory-graphql/src/model/graph/property.rs line 279: This needs to return values instead of strings
  • raphtory-graphql/src/model/graph/windowset.rs : Docs for list and count missing throughout here
  • raphtory-graphql/src/model/plugins/algorithms.rs line 57: This all needs to be redone once Wyatts PRs are in
    • Don't know the status of this
  • raphtory-graphql/src/model/schema/edge_schema.rs line 81: All functions below missing comments
  • raphtory-graphql/src/model/mod.rs line 80: Worth explainig the difference here
  • raphtory-graphql/src/model/mod.rs line 119: 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
  • raphtory-graphql/src/model/mod.rs line 159: I think you want to clarify here that this returns the the collection of query plugins, not an individual plugin
    • I could use an explanation of plugins in general
  • raphtory-graphql/src/model/mod.rs line 163: Wanna add the decode is available within the raphtory python/rust client?
    • where/how?
  • raphtory-graphql/src/model/mod.rs : varius 'how can this fail' comments

@miratepuffin
miratepuffin marked this pull request as ready for review August 22, 2025 14:09
@miratepuffin
miratepuffin merged commit 0a60409 into master Aug 22, 2025
16 of 17 checks passed
@miratepuffin
miratepuffin deleted the james/graphql-docstrings-fixes branch August 22, 2025 14:10
ljeub-pometry added a commit that referenced this pull request Sep 17, 2025
* 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 <ben.steer@pometry.com>

* Release v0.16.1 (#2236)

chore: Release

Co-authored-by: Pometry-Team <ben.steer@pometry.com>

* 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 <ben.steer@pometry.com>
Co-authored-by: Ben Steer <b.a.steer@qmul.ac.uk>

* 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 <b.a.steer@qmul.ac.uk>

* 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] <support@github.com>

* chore: apply tidy-public auto-fixes

---------

Signed-off-by: dependabot[bot] <support@github.com>
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 <b.a.steer@qmul.ac.uk>

* 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] <support@github.com>
Co-authored-by: wyatt-joyner-pometry <wyatt.joyner@pometry.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Pedro Rico Pinazo <ricopinazo@gmail.com>
Co-authored-by: James Baross <james.baross@pometry.com>
Co-authored-by: Ben Steer <ben.steer@pometry.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Ben Steer <b.a.steer@qmul.ac.uk>
Co-authored-by: edsherrington <ed.sherrington@pometry.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants