-
Notifications
You must be signed in to change notification settings - Fork 458
javadoc: Deprecate legacy classes and add migration guidance to FesodSheet #699
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
base: main
Are you sure you want to change the base?
Conversation
|
@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. |
|
😕 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 . |
|
@delei Including them can significantly reduce ambiguity and improve developer experience. |
|
I suggest adding a separate documentation directory. @delei cc |
I agree to add it as a separate page, but I recommend a subpage under |
@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: Keeping Migration Guide as a sibling of Quick Start ensures: 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? |
f56069d to
98f0eb7
Compare
|
@psxjoy PTAL |
98f0eb7 to
cdfc53e
Compare
✅ Deploy Preview for fesod ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
e809636 to
95a83a0
Compare
95a83a0 to
c2cb570
Compare
There was a problem hiding this 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
FesodSheetincluding usage examples and feature descriptions - Deprecates
EasyExcel,FastExcel, andFastExcelFactorywith 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.
fesod/src/main/java/org/apache/fesod/sheet/FastExcelFactory.java
Outdated
Show resolved
Hide resolved
fesod/src/main/java/org/apache/fesod/sheet/FastExcelFactory.java
Outdated
Show resolved
Hide resolved
…s with migration guidance to FesodSheet
Co-authored-by: Copilot <[email protected]>
5e7292c to
8b29490
Compare

Description
This PR adds deprecation notices to
EasyExcel,FastExcel, andFastExcelFactoryclasses, providing clear migration guidance to useFesodSheet. It also enhances the Javadoc forFesodSheetandFesodSheetFactory.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
FesodSheetAPI. This ensures a smoother transition and better developer experience.