Add a description to the procedure object.

[barakb]

Summary by CodeRabbit

• New Features

  • Enhanced documentation for various procedures, providing clearer descriptions of their functionalities.
  • Added a new function to retrieve procedure descriptions.

• Bug Fixes

  • Improved test assertions by excluding unnecessary documentation elements from results.

• Documentation

  • Updated multiple procedures to include descriptive parameters, enhancing clarity for end-users.

• Tests

  • Refined testing approach for procedures to improve clarity and focus on relevant outputs.

[coderabbitai[bot]]

Walkthrough

The changes in this pull request primarily involve enhancements to the documentation of various procedures within the codebase. This includes the addition of description parameters to several procedure context functions, clarifying the purpose and functionality of each procedure. A new function for retrieving procedure descriptions has also been introduced, and modifications to existing test cases have been made to improve the clarity of test outputs. Overall, the core logic of the procedures remains unchanged.

Changes

File Path	Change Summary
src/procedures/proc_bfs.c	Added description to Proc_BFS_Ctx function.
src/procedures/proc_ctx.h	Added const char *description to ProcedureCtx structure; updated ProcCtxNew function signature.
src/procedures/proc_fulltext_create_index.c	Added description parameter to Proc_FulltextCreateNodeIdxGen function.
src/procedures/proc_fulltext_drop_index.c	Added description parameter to Proc_FulltextDropIdxGen function.
src/procedures/proc_fulltext_query.c	Added description parameter to Proc_FulltextQueryNodeGen function.
src/procedures/proc_labels.c	Added description parameter to Proc_LabelsCtx function.
src/procedures/proc_list_constraints.c	Added documentation string to Proc_ConstraintsCtx function.
src/procedures/proc_list_indexes.c	Added description parameter to Proc_IndexesCtx function.
src/procedures/proc_pagerank.c	Added description string to Proc_PagerankCtx function.
src/procedures/proc_procedures.c	Added SIValue *yield_description to ProcProceduresPrivateData; updated Proc_ProceduresCtx and Proc_ProceduresInvoke.
src/procedures/proc_property_keys.c	Added description parameter to Proc_PropKeysCtx function.
src/procedures/proc_relations.c	Added description parameter to Proc_RelationsCtx function.
src/procedures/proc_sp_paths.c	Updated Proc_SPpathCtx function to include an empty string parameter.
src/procedures/proc_ss_paths.c	Updated Proc_SSpathCtx function to include an empty string parameter.
src/procedures/proc_vector_query.c	Updated Proc_VectorQueryNodeCtx and Proc_VectorQueryRelCtx to include an empty string parameter.
src/procedures/procedure.c	Added const char *Procedure_GetDescription function; updated ProcCtxNew to include description.
src/procedures/procedure.h	Added declaration for Procedure_GetDescription function.
tests/flow/test_procedures.py	Modified test10_procedure_get_all_procedures to exclude documentation noise from assertions.

Possibly related PRs

• #839: This PR modifies the handling of record order in operations, which is related to the documentation changes in the main PR that enhance the clarity of the BFS procedure's context and its parameters. Both PRs focus on improving the understanding and consistency of operations within the procedures.

Suggested labels

enhancement

Suggested reviewers

• AviAvni

Poem

In the code where rabbits hop,
Descriptions bloom, they never stop.
Procedures clear, their paths defined,
With every change, new truths we find.
So let us cheer, with joy and glee,
For clearer code, as bright as can be! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3ac48aa731a2df37e6b0fd51d6c2cc1c8cf6ddfb and b7499e042a783848c57d1ffb89339bf853b1d5b0.

📒 Files selected for processing (1)

• src/procedures/proc_list_indexes.c (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/procedures/proc_list_indexes.c

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 94.24603% with 29 lines in your changes missing coverage. Please review.

Project coverage is 89.20%. Comparing base (b89359d) to head (b7499e0).

Files with missing lines	Patch %	Lines
src/procedures/proc_ss_paths.c	92.73%	29 Missing :warning:

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #811      +/-   ##
==========================================
+ Coverage   89.17%   89.20%   +0.02%     
==========================================
  Files         337      337              
  Lines       43484    43519      +35     
==========================================
+ Hits        38778    38821      +43     
+ Misses       4706     4698       -8     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.