Update sub_show_status() reference with status values

[susan-pgedge]

This resolves spoc-361

Add a STATUS VALUES table documenting all five possible subscription states (replicating, initializing, disabled, down, unknown) derived from the C source. Fix heading markup, wrap synopsis in a fenced SQL code block, and add introductory sentences before examples.

[coderabbitai]

📝 Walkthrough

Walkthrough

The documentation for spock_sub_show_status is restructured and enhanced with improved formatting and clarity. The function signature is reformatted in SQL syntax, a STATUS VALUES table is introduced, and the EXAMPLE section is expanded with practical SQL queries for common use cases.

Changes

Cohort / File(s)

Summary

Documentation Update docs/spock_functions/functions/spock_sub_show_status.md

Function signature reformatted in SQL fenced code block with explicit DEFAULT NULL parameter. RETURNS section expanded with specific column details. New STATUS VALUES table added covering replicating, initializing, disabled, down, and unknown states. DESCRIPTION narrative rewritten with updated terminology referencing logical replication workers. ARGUMENTS section reformatted and clarified. EXAMPLE section enhanced with fenced SQL queries for both all-subscriptions and single-subscription usage patterns.

Poem

🐰 A doc so fine, now crystal clear,
SQL queries formatted with cheer,
Status values in a table arranged,
Where subscriptions' states are exchanged,
Examples guide the curious hare,
Through replication's every care!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title directly summarizes the main change: updating the sub_show_status() function reference with a new STATUS VALUES table documenting subscription states.
Description check	✅ Passed	The description is related to the changeset and provides specific details about the updates made to the sub_show_status() documentation, including the new STATUS VALUES table and other formatting improvements.
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 spoc_361_doc_update

---

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

[codacy-production]

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. Give us feedback}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/spock_functions/functions/spock_sub_show_status.md`:
- Around line 57-58: The parameter description for subscription_name in the
spock_sub_show_status documentation is indented with four spaces and is being
rendered as a code block; update the
docs/spock_functions/functions/spock_sub_show_status.md entry for
subscription_name (the parameter in the spock_sub_show_status function) by
removing the leading four-space indentation and making it plain prose (or
convert it to a proper definition-list style), so the sentence "Optional. The
name of a specific Spock subscription. If NULL (the default), the function
returns status for all subscriptions." renders as normal text instead of a code
block.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 347587e4-765b-4ed4-a2f3-09000fcafb15

📥 Commits

Reviewing files that changed from the base of the PR and between 8220306 and 0150ae7.

📒 Files selected for processing (1)

• docs/spock_functions/functions/spock_sub_show_status.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Fix parameter description formatting.

The description for subscription_name uses 4-space indentation, which markdown interprets as a code block rather than prose text. This causes rendering issues.

📝 Proposed fix to use proper markdown formatting

Option 1: Use definition list style with minimal indentation:

 subscription_name
 
-    Optional. The name of a specific Spock subscription. If NULL
-    (the default), the function returns status for all subscriptions.
+: Optional. The name of a specific Spock subscription. If NULL
+  (the default), the function returns status for all subscriptions.
 

Option 2: Remove indentation entirely:

 subscription_name
 
-    Optional. The name of a specific Spock subscription. If NULL
-    (the default), the function returns status for all subscriptions.
+Optional. The name of a specific Spock subscription. If NULL
+(the default), the function returns status for all subscriptions.
 

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	Optional. The name of a specific Spock subscription. If NULL
	(the default), the function returns status for all subscriptions.
	subscription_name
	: Optional. The name of a specific Spock subscription. If NULL
	(the default), the function returns status for all subscriptions.

Suggested change

	Optional. The name of a specific Spock subscription. If NULL
	(the default), the function returns status for all subscriptions.
	subscription_name
	Optional. The name of a specific Spock subscription. If NULL
	(the default), the function returns status for all subscriptions.

🧰 Tools

🪛 markdownlint-cli2 (0.22.0)

[warning] 57-57: Code block style
Expected: fenced; Actual: indented

(MD046, code-block-style)

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/spock_functions/functions/spock_sub_show_status.md` around lines 57 -
58, The parameter description for subscription_name in the spock_sub_show_status
documentation is indented with four spaces and is being rendered as a code
block; update the docs/spock_functions/functions/spock_sub_show_status.md entry
for subscription_name (the parameter in the spock_sub_show_status function) by
removing the leading four-space indentation and making it plain prose (or
convert it to a proper definition-list style), so the sentence "Optional. The
name of a specific Spock subscription. If NULL (the default), the function
returns status for all subscriptions." renders as normal text instead of a code
block.