Skip to content

feat: Use UploadHandler in documentation #4317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Jun 18, 2025
Merged

Conversation

caalador
Copy link
Contributor

fixes #4304

@caalador caalador force-pushed the issues/4304-downloadHandler branch from d950ac9 to 3456b23 Compare May 16, 2025 11:00
Copy link

github-actions bot commented May 16, 2025

AI Language Review

Here are the issues that require improvements:

  1. Upload.java:

    • Line 11: The MultiFileMemoryBuffer import is not used and should be removed for better code cleanliness.
    • Line 12: The InMemoryUploadHandler import is not necessary in all classes and should be removed where it is not used.
    • Comment at line 17 mentions "No explicit Flow API for this at the moment." Ensure this comment remains accurate and provides value. If the situation has changed or the comment adds confusion, it should be updated or removed.
    • For multi-line comments and code blocks identified with // tag::snippet[] and // end::snippet[], ensure that these tags match and are correctly placed to avoid documentation tool issues.
  2. UploadFileBuffer.java:

    • The import of InMemoryUploadHandler is not used and should be removed.
    • In comments, ensure that multi-line comments using /* */ are consistent and provide necessary context or instructions.
  3. UploadDropLabel.java:

    • Ensure consistency in using icons throughout the project. If using Vaadin components, be consistent with their style and initialization.

Each code file should be reviewed for unused imports, unnecessary comments, and ensure consistency across similar components. If comments and code blocks are intended for documentation processing tools, ensure accurate and matching tags for proper parsing.

@caalador caalador changed the title feat: Use UploadHanlder in documentation feat: Use UploadHandler in documentation May 16, 2025
@caalador caalador force-pushed the issues/4304-downloadHandler branch from 3456b23 to ed6c5c6 Compare May 16, 2025 11:14
@caalador caalador force-pushed the issues/4304-downloadHandler branch from ed6c5c6 to 90cb0c5 Compare May 16, 2025 11:14
caalador added 2 commits May 16, 2025 15:01
fix sample code in asciidoc
vaadin/flow#21443 makes the method protected
so it shouldn't be mentioned in the doc.
@mshabarov mshabarov self-requested a review May 19, 2025 11:31
Copy link
Contributor

@mshabarov mshabarov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to other comments, I'd would add to the article a description for UploadEvent, UploadMetadata and
(can be borrowed from downloads docs) also for TransferContext, allowInert, urlPostfix and disableMode.

@caalador caalador marked this pull request as ready for review May 23, 2025 06:59
@mshabarov
Copy link
Contributor

Converted to draft to not being merged before RC/GA

@mshabarov mshabarov marked this pull request as draft May 23, 2025 10:53
@mshabarov
Copy link
Contributor

Methods getRequestSizeMax, getFileSizeMax and getFileCountMax of UploadHandler should be documented.
Also responseHandled is mentioned in examples, but not described in a sentence.

@caalador caalador marked this pull request as ready for review June 17, 2025 10:59
@mshabarov mshabarov merged commit 244875b into latest Jun 18, 2025
4 of 5 checks passed
@mshabarov mshabarov deleted the issues/4304-downloadHandler branch June 18, 2025 07:02
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.

Documentation for the new Upload API
2 participants