docs: generalize upload file event descriptions#11619
Merged
web-padawan merged 1 commit intomainfrom Apr 29, 2026
Merged
Conversation
The `file-abort`, `file-retry`, and `file-start` events on `<vaadin-upload-file>` are listened to by both `<vaadin-upload>` and `<vaadin-upload-file-list>` (which forwards to its linked `UploadManager`). The previous descriptions only mentioned `<vaadin-upload>`, which is incomplete. Generalize the descriptions to focus on the request intent rather than naming a specific listener, e.g. "Fired when the abort button is pressed to request aborting the upload of this file." Update both `@fires` (one-line class-level) and `@event` (multi-line) JSDoc annotations in `.js` and `.d.ts`, plus the short `UploadFile*Event` type alias descriptions in `.d.ts`, so all four documentation surfaces stay consistent. Follow-up to #11604, addressing #11604 (comment). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
tomivirkki
approved these changes
Apr 29, 2026
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
2 participants
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
Follow-up to #11604, addressing this review comment.
The
file-abort,file-retry, andfile-startevents on<vaadin-upload-file>are listened to by both<vaadin-upload>and<vaadin-upload-file-list>(which forwards the call to its linkedUploadManager). The previous descriptions only mentioned<vaadin-upload>, which is incomplete.This PR generalizes the descriptions to focus on the request intent rather than naming a specific listener. For example:
vaadin-upload, which aborts the upload in progress and removes the file from the list.All four documentation surfaces are updated in lockstep:
@fires(one-line class-level) invaadin-upload-file.js@event(multi-line) JSDoc blocks invaadin-upload-file.js@firesinvaadin-upload-file.d.tsUploadFile{Retry,Start,Abort}Eventtype alias descriptions invaadin-upload-file.d.tsTest plan
yarn lintandyarn lint:typespass<vaadin-upload-file>shows the generalized descriptions forfile-abort,file-retry,file-start🤖 Generated with Claude Code