Skip to content

PPF-2061: Publish migration and capability guidance #2061

Closed

Description

@chinapandaman

Version

Reviewed baseline: PyPDFForm 6.0.0, commit 0b5cc1dc8604b36693864852d76ed7e60f903451.

Issue Description

The review found no consolidated 5.6-to-6.0 migration guide in the tracked documentation. At that snapshot, the minimum Python version moved from 3.10 to 3.11, the configured support/test window became 3.11–3.15, and deprecated flatten/preserve_metadata handling and corresponding CLI options were removed. General Python **kwargs acceptance could silently absorb the removed arguments. Verify these details against the release being documented.

Work

Draft the 5.6-to-6.0 migration guide and link it from appropriate documentation. Cover the Python minimum/support window at the reviewed snapshot, removed Python arguments and CLI options, and available replacements or lack of equivalents. Add a compact table distinguishing signature images, signature fields, cryptographic signing, read-only fields, and flattening.

Acceptance Criteria

  • Users can identify affected calls and supported alternatives without assuming readonly provides flattening or integrity protection. Explain the reviewed silent-keyword behavior and update the guide when E2-05 changes it. State the supported release/security policy and where viewer limitations are documented.

Basis and Dependencies

R10; report §§5.6, 7.1–7.2. Verify statements against the release being documented; do not advertise planned fixes as delivered.

Source and Validation

Action E1-08, Group 1 — Lowest-hanging fruit, from the October 10, 2026 action plan; supporting review evidence. Related action identifiers refer to that plan.

The behavior above is evidence from the source review, not a new reproduction performed when filing this issue. Reconfirm the relevant baseline or document intervening changes before implementation. Follow the plan's completion and validation rules and the Developer Guide, including meaningful regression assertions for behavior changes.

Activity

  1. changed the title [-]Publish migration and capability guidance[/-] [+]PPF-2061: Publish migration and capability guidance[/+] on Oct 11, 2026
  2. moved this from Backlog to In progress in PyPDFForm-support-2026on Oct 15, 2026
  3. moved this from In progress to In review in PyPDFForm-support-2026on Oct 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions