Add docs for spock.sub_alter_options()

[susan-pgedge]

Summary

• Adds docs/spock_functions/functions/spock_sub_alter_options.md — full reference page covering synopsis, return values, all three options (forward_origins, apply_delay, skip_schema), validation rules, and examples
• Adds spock.sub_alter_options to the function table in docs/spock_functions/sub_mgmt.md
• Adds a linked entry in docs/spock_functions/index.md

The function was introduced in 6.0.0 (noted in the release notes) but had no reference documentation.

Test plan

• Verify rendered docs link correctly from both index pages to the new function page
• Confirm option descriptions and error cases match the regression test in tests/regress/sql/alter_options.sql

🤖 Generated with Claude Code

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b5d4d8c5-4f03-495f-ae93-209a34d25885

📥 Commits

Reviewing files that changed from the base of the PR and between b2a9faf and 3c87498.

📒 Files selected for processing (1)

• mkdocs.yml

✅ Files skipped from review due to trivial changes (1)

• mkdocs.yml

---

📝 Walkthrough

Walkthrough

This PR adds documentation for the spock.sub_alter_options() subscription management function, describing its behavior, return values, supported option keys, and error conditions, with index entries in two documentation catalogs and three SQL usage examples.

Changes

spock.sub_alter_options() Documentation

Layer / File(s)	Summary
spock.sub_alter_options() function reference and index entries docs/spock_functions/functions/spock_sub_alter_options.md, docs/spock_functions/index.md, docs/spock_functions/sub_mgmt.md, mkdocs.yml	Complete function documentation with synopsis, return values, option keys (forward_origins, apply_delay, skip_schema), error conditions, and three SQL examples. Index entries added to the main function listing and subscription management section; site navigation updated.

Poem

A rabbit hops through docs so bright,
Mapping options, line by line,
apply_delay and forward sights,
Examples tucked where readers dine,
Now subscriptions shine — hop fine! 🐇✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and concisely describes the main change: adding documentation for the spock.sub_alter_options() function.
Description check	✅ Passed	The description is directly related to the changeset, clearly detailing which documentation files were added and modified to document the spock.sub_alter_options() function.
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 docs/sub-alter-options

---

_{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 current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/spock_functions/index.md`:
- Line 40: The table row for spock.sub_alter_options is missing the trailing
pipe causing markdownlint MD055 failures; update the table line containing
"[spock.sub_alter_options](functions/spock_sub_alter_options.md) | Change one or
more subscription options in a single atomic operation." to include a trailing
"|" so the row ends with "...operation. |" (i.e., add the final pipe to the row
for spock.sub_alter_options).

🪄 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: a9bf03a6-339b-4f11-b1e4-93706cf510e2

📥 Commits

Reviewing files that changed from the base of the PR and between 94f4ad6 and b2a9faf.

📒 Files selected for processing (3)

• docs/spock_functions/functions/spock_sub_alter_options.md
• docs/spock_functions/index.md
• docs/spock_functions/sub_mgmt.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix table pipe style on this new row.

Line 40 is missing the trailing |, which matches the MD055 warning and can break markdownlint checks.

Suggested fix

-| [spock.sub_alter_options](functions/spock_sub_alter_options.md) | Change one or more subscription options in a single atomic operation.
+| [spock.sub_alter_options](functions/spock_sub_alter_options.md) | Change one or more subscription options in a single atomic operation. |

📝 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

	| [spock.sub_alter_options](functions/spock_sub_alter_options.md) | Change one or more subscription options in a single atomic operation.
	| [spock.sub_alter_options](functions/spock_sub_alter_options.md) | Change one or more subscription options in a single atomic operation. |

🧰 Tools

🪛 markdownlint-cli2 (0.22.1)

[warning] 40-40: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

🤖 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/index.md` at line 40, The table row for
spock.sub_alter_options is missing the trailing pipe causing markdownlint MD055
failures; update the table line containing
"[spock.sub_alter_options](functions/spock_sub_alter_options.md) | Change one or
more subscription options in a single atomic operation." to include a trailing
"|" so the row ends with "...operation. |" (i.e., add the final pipe to the row
for spock.sub_alter_options).

Source: Linters/SAST tools

[danolivo]

  forward_origins

        A JSON array of origin names whose transactions the subscriber
        should forward. 

The direction is inverted: nothing "forwards" on the subscriber side; the option controls which changes this subscription applies/receives based on their origin.