Skip to content

Conversation

@GOODBOY008
Copy link
Member

Description

This PR adds deprecation notices to EasyExcel, FastExcel, and FastExcelFactory classes, providing clear migration guidance to use FesodSheet. It also enhances the Javadoc for FesodSheet and FesodSheetFactory.

Motivation

As part of the rebranding from FastExcel to Fesod, it is important to guide users away from the old entry points and towards the new FesodSheet API. This ensures a smoother transition and better developer experience.

@GOODBOY008
Copy link
Member Author

@psxjoy I think it would be helpful to provide a migration guide to walk users through the migration steps. I’m happy to contribute this migration document to the Fesod website.

@delei
Copy link
Member

delei commented Nov 20, 2025

😕 It appears that such specificity (such as code examples) is not required in the JavaDoc. I recommend adding documentation for this section to the official website when releasing the first ASF version.

BTW, this PR appears to conflict with PR #688 .

@GOODBOY008
Copy link
Member Author

@delei Including them can significantly reduce ambiguity and improve developer experience.
Relying solely on the website means users may miss critical context while reading the API. Since JavaDoc is often the first place developers look, providing concrete examples here helps make the API more self-explanatory.
Therefore, I still believe adding these details directly in the JavaDoc is beneficial.

@GOODBOY008
Copy link
Member Author

@psxjoy I think it would be helpful to provide a migration guide to walk users through the migration steps. I’m happy to contribute this migration document to the Fesod website.

@delei Do you have any suggestions on this?

@delei
Copy link
Member

delei commented Nov 20, 2025

@delei Do you have any suggestions on this?

How about adding this to the Guide page?

@GOODBOY008
Copy link
Member Author

I suggest adding a separate documentation directory. @delei cc
企业微信截图_25a727e9-f0d7-4cb2-8754-fd5e1ab03b9c

@delei
Copy link
Member

delei commented Nov 20, 2025

I suggest adding a separate documentation directory.

I agree to add it as a separate page, but I recommend a subpage under Quick Start, such as the Version Upgrade Guide.

@GOODBOY008
Copy link
Member Author

I suggest adding a separate documentation directory.

I agree to add it as a separate page, but I recommend a subpage under Quick Start, such as the Version Upgrade Guide.

@delei Thanks for the suggestion!

Quick Start is for new users, while a Migration Guide targets existing users upgrading from an older version. These are different audiences, so nesting migration content inside Quick Start could confuse readers.

For example:
• Vue Migration Guide (top-level): https://v2.vuejs.org/v2/guide/migration
• JUnit 4 → 5 Migration (top-level): https://docs.junit.org/current/user-guide/#migrating-from-junit4

Keeping Migration Guide as a sibling of Quick Start ensures:
1. Clear separation between onboarding and upgrade content
2. Easier discoverability for migrating users
3. Cleaner, more focused Quick Start section

I recommend placing Migration Guide at the top level rather than inside Quick Start.

@psxjoy Would you like to join this discussion and share your thoughts on this subject?

@GOODBOY008
Copy link
Member Author

@psxjoy PTAL

@psxjoy psxjoy added the PR: reviewing Currently under active review. label Nov 23, 2025
@netlify
Copy link

netlify bot commented Nov 24, 2025

Deploy Preview for fesod ready!

Name Link
🔨 Latest commit e809636
🔍 Latest deploy log https://app.netlify.com/projects/fesod/deploys/6925142a8902640008673423
😎 Deploy Preview https://deploy-preview-699--fesod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@GOODBOY008 GOODBOY008 changed the title refactor: Deprecate legacy classes and add migration guidance to FesodSheet javadoc: Deprecate legacy classes and add migration guidance to FesodSheet Nov 28, 2025
Copilot AI review requested due to automatic review settings December 4, 2025 02:18
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances documentation as part of the rebranding from FastExcel/EasyExcel to Apache Fesod by adding comprehensive Javadoc to FesodSheet and deprecation notices with migration guidance to legacy alias classes.

  • Adds detailed Javadoc documentation to FesodSheet including usage examples and feature descriptions
  • Deprecates EasyExcel, FastExcel, and FastExcelFactory with clear migration paths
  • Provides migration tables showing old vs. new code examples for each deprecated class

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
fesod/src/main/java/org/apache/fesod/sheet/FesodSheet.java Enhanced class-level Javadoc with comprehensive documentation, code examples, and cross-references to guide developers using the Fesod library
fesod/src/main/java/org/apache/fesod/sheet/FastExcelFactory.java Added detailed deprecation notice with migration guide, historical context, and table-based migration examples to transition from FastExcelFactory to FesodSheet
fesod/src/main/java/org/apache/fesod/sheet/FastExcel.java Added detailed deprecation notice with migration guide, branding context, and table-based migration examples to transition from FastExcel to FesodSheet
fesod/src/main/java/org/apache/fesod/sheet/EasyExcel.java Added deprecation notice with migration guide and table-based examples to transition from EasyExcel to FesodSheet

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@GOODBOY008
Copy link
Member Author

@psxjoy @delei I believe the Javadoc is also important for our developers, as it helps them understand the source code and learn the latest usage guidelines. PTAL~

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

Labels

PR: reviewing Currently under active review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants