docs: what the guides said that the code no longer does - #62
Merged
Conversation
The grant comment in the container guide claimed USAGE and CREATE on the schema are enough to create and attach partitions; PostgreSQL lets only the parent's owner do either, so the comment now says the grant is needed and not sufficient. The rest is drift since 1.2.0 through 1.5.0: PostgreSQL 15 through 18 under test, backfill among the commands, the tree read over pg_inherits, three differences between the mirrors, after_* hook exceptions re-raised, a Python block hook no longer holding a stop, eight hook moments, the hand-maintained mirror files as the script lists them, and 1.5.x as the release the security policy supports.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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
Reading the docs against the code for a blog post turned up statements that stopped being true, most of them between 1.2.0 and 1.5.0. Prose only; no behaviour changes.
guide/container.md: the grant comment saidUSAGE, CREATEon the schema is enough to create and attach partitions. It is not: PostgreSQL lets only the parent's owner runCREATE TABLE … PARTITION OF,ATTACHandDETACH(checked on 17:must be owner of table events). The comment now says the schema grant is needed and not sufficient.agents.md,getting-started/installation.md: tested on 15 through 18, as CI runs, not "15, 16 and 17".README.md:backfillin the command list; the tree is read by a recursive walk overpg_inherits, notpg_partition_tree;PlanStaleErrorstops the run unlesscontinue_on_error; three behavioural differences between the mirrors since 1.3.0;after_*hook exceptions are re-raised, not only logged.guide/cli.md: a Python block hook no longer holds the stop (1.3.0); the "no--sql" paragraph no longer names the DEFAULT-sibling fallback, which 1.5.0 plans.guide/archiving.md: eight moments, not six.guide/running.md,pg_partsmith/cli/__init__.py: five commands,backfillin the table.CONTRIBUTING.md: the hand-maintained mirror files asscripts/sync_mirror.pylists them.SECURITY.md: 1.5.x is the current release.Type of change
Checklist
tests/unit/test_guides.pyandtests/unit/test_examples.pypassmake checkpasses locally (ruff+mypy)CHANGELOG.mdupdated under[Unreleased]— docs commits stay out of the changelog since ci: keep docs commits out of releases #61Related issues
None.