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

Documentation for spock.sub_show_status was updated: the function signature now accepts subscription_name name DEFAULT NULL; the RETURNS section lists result columns; a STATUS VALUES table was added; DESCRIPTION was rewritten to reference catalog metadata and logical replication worker state; and an all-subscriptions SQL example was added.

Changes

Cohort / File(s)

Summary

Documentation Update docs/spock_functions/functions/spock_sub_show_status.md

Function signature changed to spock.sub_show_status(subscription_name name DEFAULT NULL). RETURNS section expanded to list result columns (subscription name, status, provider node/DSN, slot name, replication sets, forwarded origins). Added STATUS VALUES table (replicating, initializing, disabled, down, unknown). DESCRIPTION rewritten to reference catalog metadata and logical replication worker state and to clarify no configuration is modified. EXAMPLE section adds an all-subscriptions SQL example and clarifies single-subscription usage.

Poem

🐰 I hopped through docs with ink-stained paws,
A signature set with DEFAULT cause,
Statuses spelled in tidy rows,
Examples show how insight grows,
Replication's tale now plainly told,
A little rabbit's joy—bold and gold.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main change: adding status values documentation and updating the sub_show_status() reference.
Description check	✅ Passed	The description is directly related to the changeset, explaining the addition of a STATUS VALUES table, fixing heading markup, and adding introductory sentences.
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.}

[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

[mason-sharp]

Looks like there are merge conflicts.

[coderabbitai]

🧹 Nitpick comments (1)

docs/spock_functions/functions/spock_sub_show_status.md (1)

17-23: Optional wording polish for the Returns bullets.

Lines 17-23 repeatedly start with “the”; consider parallel concise labels (or a small column table) to make scanning easier.

🤖 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 17 -
23, Replace the repeated "the" phrasing in the Returns bullets of
docs/spock_functions/functions/spock_sub_show_status.md with concise, parallel
labels (e.g., "Subscription name", "Replication status", "Provider node",
"Connection string", "Logical replication slot", "Replication sets", "Forwarded
origins") or convert the list into a compact two-column table with label and
short description so the items scan easily while preserving the same
information; update the Returns section for clarity under the
spock_sub_show_status documentation.

🤖 Prompt for all review comments with AI agents

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

Nitpick comments:
In `@docs/spock_functions/functions/spock_sub_show_status.md`:
- Around line 17-23: Replace the repeated "the" phrasing in the Returns bullets
of docs/spock_functions/functions/spock_sub_show_status.md with concise,
parallel labels (e.g., "Subscription name", "Replication status", "Provider
node", "Connection string", "Logical replication slot", "Replication sets",
"Forwarded origins") or convert the list into a compact two-column table with
label and short description so the items scan easily while preserving the same
information; update the Returns section for clarity under the
spock_sub_show_status documentation.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 60d28f5c-1678-4d54-ba57-aa7311d8cda1

📥 Commits

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

📒 Files selected for processing (1)

• docs/spock_functions/functions/spock_sub_show_status.md