Fix documentation inaccuracies based on source code analysis #327
Conversation
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
This commit addresses 10 documentation issues identified by comparing docs against the Spock source code: 1. limitations.md: Clarify encoding requirement (matching, not UTF-8 specific) 2. limitations.md: TRUNCATE RESTART IDENTITY is actually replicated 3. limitations.md: REPLICA IDENTITY FULL works with Delta-Apply + PK 4. limitations.md: Deferrable constraints are silently skipped in conflict detection 5. limitations.md: Add Delta-Apply NOT NULL requirement section 6. README.md: Explicitly list supported PG versions (15, 16, 17, 18) 7. two_node_cluster.md: Fix subscriber_dsn -> provider_dsn parameter 8. index.md: Add PostgreSQL 18 to supported versions 9. sub_mgmt.md: Fix sub_enable description (start, not stop) 10. node_mgmt.md: Fix node_drop example description Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR fixes 10 documentation inaccuracies identified by comparing the docs against the Spock source code.
High Severity Fixes
spock_apply.c:1610-1709) shows it IS replicatedspock_apply_heap.c:613-627)subscriber_dsn→provider_dsnMedium Severity Fixes
spock_apply.c:1858-1868)sub_enabledescription ("stop" → "start")node_dropexample descriptionLow Severity Fixes
Files Changed
docs/limitations.md- 5 fixesdocs/two_node_cluster.md- parameter name fixdocs/index.md- PG 18docs/spock_functions/sub_mgmt.md- sub_enable descriptiondocs/spock_functions/node_mgmt.md- node_drop descriptionREADME.md- PG version listVerification
All changes were verified against Spock source code with specific file:line references documented in the commit.
🤖 Generated with Claude Code