Skip to content

Fix missing schema name in spock_version and spock_version_num docs#465

Open
zaidshabbir25 wants to merge 2 commits into
mainfrom
zaidshabbir25-patch-spock_functions_doc
Open

Fix missing schema name in spock_version and spock_version_num docs#465
zaidshabbir25 wants to merge 2 commits into
mainfrom
zaidshabbir25-patch-spock_functions_doc

Conversation

@zaidshabbir25
Copy link
Copy Markdown
Contributor

Fix missing schema name in spock_version and spock_version_num docs

Updated function name to include the 'spock.' schema.
Updated function references to include the 'spock.' schema.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation for two Spock version-query functions (spock_version and spock_version_num) updated to reference fully qualified function names with the spock. namespace prefix throughout signatures, synopses, and SQL examples.

Changes

Spock Function Documentation

Layer / File(s) Summary
spock_version Documentation
docs/spock_functions/functions/spock_version.md
Function signature and synopsis updated from spock_version() to spock.spock_version(). SQL example updated to call the qualified function name.
spock_version_num Documentation
docs/spock_functions/functions/spock_version_num.md
Function definition header, synopsis, and SQL example updated from spock_version_num() to spock.spock_version_num() to match namespace qualification standard.

Poem

🐰 Fully qualified names now shine so bright,
Spock functions namespaced left and right,
Documentation revised with care and grace,
Each example now knows its rightful place!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding missing schema names (spock.) to function references in documentation for spock_version and spock_version_num.
Description check ✅ Passed The description is directly related to the changeset, explaining that the PR fixes missing schema qualification for the two functions in documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch zaidshabbir25-patch-spock_functions_doc

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codacy-production
Copy link
Copy Markdown

codacy-production Bot commented May 8, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@zaidshabbir25 zaidshabbir25 requested a review from mason-sharp May 8, 2026 12:49
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (3)
docs/spock_functions/functions/spock_version.md (1)

7-7: 💤 Low value

Minor: Inconsistent spacing before parentheses.

The SYNOPSIS section (line 7) has a space before the parentheses: spock.spock_version (), while the NAME section (line 3) and SQL example (line 16) don't: spock.spock_version(). Consider removing the space on line 7 for consistency with standard function call notation.

✨ Suggested formatting fix
-`spock.spock_version ()`
+`spock.spock_version()`
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/spock_functions/functions/spock_version.md` at line 7, SYNOPSIS has
inconsistent spacing for the function call: change the entry
`spock.spock_version ()` to remove the extra space so it matches the NAME and
examples; update the SYNOPSIS line referencing spock.spock_version to
`spock.spock_version()` to maintain consistent function call notation across the
document.
docs/spock_functions/functions/spock_version_num.md (2)

3-3: 💤 Low value

Minor: Consider adding backticks for consistency with spock_version.md.

The NAME and SYNOPSIS sections in this file don't use backticks around the function name, while the corresponding sections in spock_version.md do. Consider wrapping the function names in backticks for consistent formatting across related documentation files.

✨ Suggested formatting fix
-spock.spock_version_num()
+`spock.spock_version_num()`
-spock.spock_version_num ()
+`spock.spock_version_num()`

Also applies to: 7-7

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/spock_functions/functions/spock_version_num.md` at line 3, The NAME and
SYNOPSIS entries should use inline code formatting for consistency: update the
occurrences of spock.spock_version_num() in this document to be wrapped in
backticks (`spock.spock_version_num()`), matching the style used in
spock_version.md; ensure both the NAME and SYNOPSIS sections are updated so all
function-name occurrences are consistently backticked.

7-7: 💤 Low value

Minor: Inconsistent spacing before parentheses.

The SYNOPSIS section (line 7) has a space before the parentheses: spock.spock_version_num (), while the NAME section (line 3) and SQL example (line 36) don't: spock.spock_version_num(). Consider removing the space on line 7 for consistency with standard function call notation.

✨ Suggested formatting fix
-spock.spock_version_num ()
+spock.spock_version_num()
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/spock_functions/functions/spock_version_num.md` at line 7, The SYNOPSIS
entry has inconsistent spacing: change "spock.spock_version_num ()" to
"spock.spock_version_num()" to match the NAME and SQL example; update the
SYNOPSIS line containing the symbol spock.spock_version_num so there is no space
before the parentheses and ensure it now matches the other occurrences.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/spock_functions/functions/spock_version_num.md`:
- Line 3: The NAME and SYNOPSIS entries should use inline code formatting for
consistency: update the occurrences of spock.spock_version_num() in this
document to be wrapped in backticks (`spock.spock_version_num()`), matching the
style used in spock_version.md; ensure both the NAME and SYNOPSIS sections are
updated so all function-name occurrences are consistently backticked.
- Line 7: The SYNOPSIS entry has inconsistent spacing: change
"spock.spock_version_num ()" to "spock.spock_version_num()" to match the NAME
and SQL example; update the SYNOPSIS line containing the symbol
spock.spock_version_num so there is no space before the parentheses and ensure
it now matches the other occurrences.

In `@docs/spock_functions/functions/spock_version.md`:
- Line 7: SYNOPSIS has inconsistent spacing for the function call: change the
entry `spock.spock_version ()` to remove the extra space so it matches the NAME
and examples; update the SYNOPSIS line referencing spock.spock_version to
`spock.spock_version()` to maintain consistent function call notation across the
document.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fbfad557-9d97-4e61-8e4f-dd103bc2a0f5

📥 Commits

Reviewing files that changed from the base of the PR and between f0a3d64 and e82af24.

📒 Files selected for processing (2)
  • docs/spock_functions/functions/spock_version.md
  • docs/spock_functions/functions/spock_version_num.md

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.

1 participant