Skip to content

[#451] DOCS: audit pre-rc11 CHANGELOG TODOs for Selene 2.x - #680

Open
aleksandr-kotlyar wants to merge 1 commit into
yashaka:selene-2.0.0rc10+from
aleksandr-kotlyar:451-changelog-todo-audit-for-2.0
Open

aleksandr-kotlyar wants to merge 1 commit into
yashaka:selene-2.0.0rc10+from
aleksandr-kotlyar:451-changelog-todo-audit-for-2.0

Conversation

@aleksandr-kotlyar

Copy link
Copy Markdown
Collaborator

Summary

Audits the old TODO / placeholder sections in CHANGELOG.md that were left before and around the 2.0.0rc10 notes, and turns them into a smaller, evidence-based release-management update.

This PR is intentionally documentation-only:

  • no public API changes;
  • no speculative cleanup without evidence;
  • no broad backports from master.

What changed

  • replaced the large pre-rc10 scratchpad TODO blocks with a shorter 2.0.0 release readiness section;
  • kept only the items that still need an explicit maintainer decision before final 2.0.0;
  • moved clearly non-blocking / future-facing ideas into a Post-2.0 backlog / tracked separately subsection;
  • replaced vague TODOs with existing issue references where available;
  • removed/trimmed rc11 placeholder items that are already implemented and already documented elsewhere in the changelog;
  • corrected the command.long_press(...) note to match the current implementation.

Audit table

TODO item Classification Evidence Action taken
element.click_with_offset DONE_IN_2X Implemented via Element.click(xoffset=..., yoffset=...) in selene/core/entity.py; covered by integration/unit tests; already documented in rc9 notes Removed from TODO scratchpad
case-insensitive have.attribute(...).value(...) DONE_IN_2X Implemented in selene/core/match.py; warning/test coverage exists in unit tests Removed from TODO scratchpad
element.type on invisible element should fail DONE_IN_2X Covered by integration tests in tests/integration/element__type_test.py Removed from TODO scratchpad
set window size inside driver factory DONE_IN_2X Implemented in selene/core/configuration.py; covered by unit/integration tests Removed from TODO scratchpad
rc11 query.js.shadow_root(s) placeholder DONE_IN_2X Implemented in selene/core/query.py; covered by integration tests and docs Kept as release note, not TODO
rc11 TinyMCE local demo placeholder DONE_IN_2X Reflected in tests/const.py, workflow, docs, and tools/tinymce-local/ Kept as release note, not TODO
rc11 command.py additions/docs DONE_IN_2X Implemented in selene/core/command.py; covered by tests/module docs Kept as release note, corrected wording
rc11 Windows screenshot/pagesource path placeholder DONE_IN_2X Already fixed and covered by tests; already documented in rc10 section Removed duplicate placeholder
locator description customization ALREADY_TRACKED Existing issues #439 and #438 Replaced vague TODO with issue references
handled pytest.raises(TimeoutException) artifacts ALREADY_TRACKED Existing issue #637 Replaced vague TODO with issue reference
config._reset_not_alive_driver_on_get_url naming RELEASE_BLOCKER_DECISION Still public/typed in 2.x; old changelog explicitly notes possible rename before final 2.0 Kept in release-readiness section
config.wait(entity) deprecation question RELEASE_BLOCKER_DECISION Public API still exists alongside lower-level wait strategy Kept in release-readiness section
... vs None as managed-driver default sentinel RELEASE_BLOCKER_DECISION Still unresolved in current implementation/typing Kept in release-readiness section
deprecate be.present RELEASE_BLOCKER_DECISION Still current API in 2.x; master has later deprecation direction, but not backported here Kept in release-readiness section
remaining scratchpad ideas (all.* improvements, stacktraces, ActionChains retries, examples, __all__, soft assertions, etc.) POST_2_0_BACKLOG No strong evidence that they are release blockers for 2.0.0 Moved out of release-blocking TODOs into backlog summary
outer_html rendering question / Safari text trim UNKNOWN_NEEDS_MAINTAINER_DECISION Not enough evidence from 2.x code/history alone to classify as fixed or blocker Left out of resolved claims; not promoted to release blocker

Why this shape

The goal here is to keep the public changelog readable for users while still preserving release-management signal for maintainers.

The old sections mixed together:

  • already shipped work,
  • internal design notes,
  • future ideas,
  • and a few real pre-2.0 decisions.

This PR separates those categories without introducing new product decisions.

Scope / non-goals

Not in scope:

  • implementing missing APIs;
  • renaming public APIs;
  • backporting broader master refactors;
  • resolving long-standing design discussions in the changelog itself.

Checks

  • git diff --check

Tests were not run because this PR only changes CHANGELOG.md.

Final note

After this cleanup:

  • resolved TODOs are no longer left as stale changelog debt;
  • the remaining 2.0 blockers are explicitly visible;
  • non-blocking ideas are deferred out of the main release notes.

@aleksandr-kotlyar aleksandr-kotlyar changed the title [#451] DOCS: audit pre-rc10 CHANGELOG TODOs for Selene 2.x [#451] DOCS: audit pre-rc11 CHANGELOG TODOs for Selene 2.x May 31, 2026
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.

1 participant