Deprecations: the message-method options, and Removed gets its own section - #320
Merged
Merged
Conversation
…ction Four gaps on resources/deprecations.md, found by reading it against abap2UI5 main (37302cb) rather than against the last docs change. - The UI5 options of message_toast_display( ) and message_box_display( ) were missing entirely. #2748 took eleven parameters off the toast and five off the box, and unlike the six removals recorded before it this one breaks a caller at COMPILE time on the parameter rather than relocating a name - the one entry on the page that shortens a signature. Added to the version-status table and as a section, with the cs_event-control_global replacement and a pointer to Message, which already carried the option tables. - Five sections reading "**Removed.**" sat under the H2 "Obsolete: still compiles", which promises the opposite of what they say. They move to their own H2: the view parameter, wizard_set_next_step, the URL API, check_allow_multi_req and the new message entry. - The invisible-controls table listed a `SoftKeyboard` control under a paragraph reading "The controls still ship". There is no such control anywhere in the framework - only the cs_event-keyboard_set_mode event, which is current API and not a deprecation. Row dropped. - The two AJSON-replacement samples linked src/00; samples #843 moved them into src/01, so both links 404'd. Repointed. Two generated artefacts were stale on main and are regenerated here: the Working Samples blocks on eight pages (the same src/01 move) and the client API reference, which had not picked up cs_event-store_data from #2755. Gates: test, check:version, docs:build, check:cross-site, check:images, check:examples, check:conventions, check:playground, check:api-names, check:api-reference and check:samples all green. `build` and check:design could not run in this container - both borrow from the published playground and the network policy here answers 403 for abap2ui5.github.io; neither reads a file this commit touches. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01K1onp9KRonb7yrY7M3vhNS
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
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.
Read
resources/deprecations.mdagainst abap2UI5main(37302cb) rather than against the last docs change. Most of it was already current — #318 and #319 caught the seven-name removal and the JSON reader yesterday — but four things were not.The message-method options were missing entirely
abap2UI5#2748 took eleven parameters off
message_toast_display( )(width,my,at,of,offset,collision,autoclose,animationtimingfunction,animationduration,closeonbrowsernavigation,class) and five offmessage_box_display( )(textdirection,icon,closeonnavigation,dependenton,contentwidth). It is in the framework's changelog as- BREAKING:and, unlike the six removals recorded before it, it breaks a caller at compile time on the parameter rather than relocating a name — the one entry on the page that shortens a signature.Nothing on the deprecations page said so: no row in the version-status table, no section. The options were documented only on Message and Frontend Actions, which is where a reader goes to write a message, not where they go to find out what their existing code has to stop doing. Added both, with the
cs_event-control_globalreplacement and a pointer to Message, which already carries the per-control option tables."Removed" sections under a heading promising the opposite
Five sections reading Removed. sat under the H2
## Obsolete: still compiles. They move to their own## Removed: does not compile any more: theviewparameter,cs_event-wizard_set_next_step, the URL API,check_allow_multi_req, and the new message entry. No prose in the moved sections changed.A control that does not exist
The invisible-controls table listed a
SoftKeyboardcontrol, under a paragraph reading "The controls still ship and views that use them keep rendering". There is no such control anywhere in the framework —grep -ri softkeyboardover abap2UI5 is empty andapp/webapp/cc/has no such file. Onlycs_event-keyboard_set_modeexists, which is current API and not a deprecation. Row dropped; the Soft Keyboard page it pointed at is still linked from Keyboard Shortcuts.Two dead sample links
The two AJSON-replacement rows linked
src/00/z2ui5_cl_smp_app_507and_509. samples#843 moved them intosrc/01, so both 404'd. Repointed —check:samplesis what found these.Regenerated, stale on main
src/00→src/01move (npm run link:samples).cs_event-store_datafrom abap2UI5#2755 (npm run generate:api).Both were already failing on
mainbefore this branch; neither is a hand edit.Gates
test,check:version,docs:build,check:cross-site,check:images,check:examples,check:conventions,check:playground,check:api-names,check:api-referenceandcheck:samplesare green locally.buildandcheck:designcould not run in this container: both borrow their four shared assets from the published playground, and this environment's network policy answers 403 forabap2ui5.github.io(no built playground checkout here either). Neither reads a file this PR touches — CI runs both.One note for whoever works in a container next: the sibling clones' local
mainrefs were up to 18 commits behind their remotes, andgenerate:apireadsA2UI5_HOMEatmainwithgit show. Running it against a stale ref silently reverts the API reference — it re-addedcheck_allow_multi_reqhere before the refs were fast-forwarded. Worth agit fetchbefore trusting a generator's output.🤖 Generated with Claude Code
https://claude.ai/code/session_01K1onp9KRonb7yrY7M3vhNS
Generated by Claude Code