Skip to content

Document Introduce Parameter and default-value semantics - #967

Open
Aschenbath wants to merge 1 commit into
python-rope:masterfrom
Aschenbath:codex/oss20c-20261122-rope-introduce-parameter-docs
Open

Aschenbath wants to merge 1 commit into
python-rope:masterfrom
Aschenbath:codex/oss20c-20261122-rope-introduce-parameter-docs

Conversation

@Aschenbath

Copy link
Copy Markdown

Description

Introduce Parameter exists but only has a one-line entry in the library guide. Add a before/after overview and a complete API example covering the reference offset, preparing changes, applying them through Project.do(), undo, and project cleanup.

Explain supported selections and the consequences of evaluating defaults at definition time, sharing mutable defaults, and moving expressions that depend on local scope. No refactoring implementation changes.

Fixes #122.

Validation

  • Executed the exact API example, including unchanged-before-apply, expected output, and undo assertions.
  • Sphinx HTML with -W passes.
  • Full pytest suite on Python 3.12 / Windows: 2173 passed, 12 skipped, 5 xfailed; existing deprecation warnings remain.

Checklist

  • Updated the changelog, user overview, and library documentation.
  • Verified the documentation example and existing tests.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document IntroduceParameter refactoring

1 participant