Documentation review changes#460
Merged
Merged
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis pull request updates Spock documentation: it narrows conflict-resolution options to ChangesSpock Documentation API Clarification
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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. Comment |
Up to standards ✅🟢 Issues
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 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/modify/zodan/zodan_tutorial.md`:
- Around line 755-756: The doc currently lists "1200 seconds = 20 minutes" here
but earlier mentions an "internal 180-second timeout"; reconcile by either
aligning the numbers or adding an explicit clarification: update the sentence
that reads "The timeout (1200 seconds = 20 minutes) prevents waiting forever if
something goes wrong." to explain that the 1200s value is the overall
operation/monitoring timeout while ZODAN's internal per-request timeout remains
180 seconds (or change one of the values so both refer to the same timeout), and
also update the earlier "internal 180-second timeout" sentence to reference the
overall timeout if you choose to keep 1200s—ensure both phrases ("1200 seconds =
20 minutes" and "internal 180-second timeout") are consistent or clearly
differentiated in wording.
- Around line 847-848: The examples documenting pg_replication_slot_advance
incorrectly declare the result as AS t(result bool); update both occurrences to
reflect the actual return signature of pg_replication_slot_advance by using a
record type with the two columns (slot_name name, end_lsn pg_lsn) so the
examples match PostgreSQL v17/v18 and will copy/paste without errors; locate the
examples around the pg_replication_slot_advance usage and replace the incorrect
AS t(result bool) with an AS clause declaring (slot_name name, end_lsn pg_lsn)
for both instances.
In `@docs/monitoring/spock_sync_event.md`:
- Around line 71-78: The earlier inline call to spock.wait_for_sync_event() is
misleading because the function requires parameters; update the intro/reference
(where it currently shows spock.wait_for_sync_event() on Line 19) to a symbolic
form such as spock.wait_for_sync_event(...) so readers know it’s illustrative
and not a valid zero-arg invocation; ensure references to the procedure name
spock.wait_for_sync_event and the OUT placeholder usage (NULL) remain consistent
with the full example shown later.
In `@docs/spock_functions/gen_mgmt.md`:
- Around line 8-12: The table rows for spock_max_proto_version,
spock_min_proto_version, spock.node_info, spock_version, and spock_version_num
use trailing pipe style; update each row in docs/spock_functions/gen_mgmt.md to
use the markdownlint MD055 "leading_only" pipe style by removing the trailing
pipe at the end of each table line while keeping the same cell order and content
so the table renders identically but complies with the linter.
In `@docs/spock_functions/index.md`:
- Around line 23-25: The table rows for the spock function links (e.g.,
spock.repset_add_seq, spock.repset_add_all_seqs, spock.repset_remove_seq and the
other rows around the 44-53 block) are using leading-only pipe style; update
each Markdown table row to include trailing pipes so the table uses
leading_and_trailing style (add a trailing "|" at the end of each affected row)
to satisfy MD055.
In `@docs/spock_functions/repset_mgmt.md`:
- Around line 213-214: The quick-start "Removing a Table" SQL snippet uses the
old two-argument form; update that snippet to match the documented signature
spock.repset_remove_table(set_name name, relation regclass, include_partitions
boolean DEFAULT true) by adding the include_partitions boolean argument
(true/false as appropriate) to the call so both snippets show the same
three-argument form and reflect the include_partitions behavior.
🪄 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: 78ffb7ac-e7ef-4502-9463-0a34d1e58f7b
📒 Files selected for processing (27)
README.mddocs/configuring.mddocs/conflict_types.mddocs/limitations.mddocs/managing/read_only.mddocs/managing/spock_autoddl.mddocs/modify/zodan/zodan_tutorial.mddocs/monitoring/spock_info.mddocs/monitoring/spock_sync_event.mddocs/recovery/catastrophic_node_failure.mddocs/spock_functions/functions/spock_max_proto_version.mddocs/spock_functions/functions/spock_min_proto_version.mddocs/spock_functions/functions/spock_node_drop_interface.mddocs/spock_functions/functions/spock_repset_add_seq.mddocs/spock_functions/functions/spock_repset_add_table.mddocs/spock_functions/functions/spock_repset_remove_seq.mddocs/spock_functions/functions/spock_repset_remove_table.mddocs/spock_functions/functions/spock_sub_add_repset.mddocs/spock_functions/functions/spock_sub_alter_interface.mddocs/spock_functions/functions/spock_sync_event.mddocs/spock_functions/gen_mgmt.mddocs/spock_functions/index.mddocs/spock_functions/repset_mgmt.mddocs/spock_functions/sub_mgmt.mddocs/spock_release_notes.mddocs/troubleshooting.mddocs/two_node_cluster.md
Clarify function definition location and add details.
Clarify the schema definition of the spock_min_proto_version function and its read-only nature.
Added notes about argument requirements for Spock functions.
There was a problem hiding this comment.
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/gen_mgmt.md`:
- Around line 89-99: The return description for spock_version is incorrect:
update the wording in the spock_version() documentation so it says the function
returns a version string (e.g., "Returns the version string of the Spock
extension") instead of "version number"; locate the spock_version section and
change the phrasing where it currently reads "version number" to "version
string" to ensure consistency with the function's actual return type.
🪄 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: 74f75a16-e138-4070-9761-c3bc51c49ca8
📒 Files selected for processing (1)
docs/spock_functions/gen_mgmt.md
susan-pgedge
approved these changes
May 12, 2026
Member
susan-pgedge
left a comment
susan-pgedge
left a comment
There was a problem hiding this comment.
I made a few little changes, and checked them in - looks great, thank you!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.