You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fesod.apache.org by "GOODBOY008 (via GitHub)" <gi...@apache.org> on 2025/11/20 05:52:16 UTC
[PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
GOODBOY008 opened a new pull request, #699:
URL: https://github.com/apache/fesod/pull/699
## 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3556517812
I suggest adding a separate documentation directory. @delei cc
<img width="323" height="276" alt="企业微信截图_25a727e9-f0d7-4cb2-8754-fd5e1ab03b9c" src="https://github.com/user-attachments/assets/13ee6417-b2c8-43b4-b0ae-41ffb9c128dc" />
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] javadoc: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3636177872
@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~
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "delei (via GitHub)" <gi...@apache.org>.
delei commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3556153403
> @delei Do you have any suggestions on this?
How about adding this to the [Guide](https://fesod.apache.org/docs/quickstart/guide) page?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3556001998
@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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "netlify[bot] (via GitHub)" <gi...@apache.org>.
netlify[bot] commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3568675127
### <span aria-hidden="true">👷</span> Deploy Preview for *fesod* processing.
| Name | Link |
|:-:|------------------------|
|<span aria-hidden="true">🔨</span> Latest commit | cdfc53e267e1b9fbe8b8f99a950fb74fa2b4c7d2 |
|<span aria-hidden="true">🔍</span> Latest deploy log | https://app.netlify.com/projects/fesod/deploys/6923ba68c6cbee0008f3e35d |
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] javadoc: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #699:
URL: https://github.com/apache/fesod/pull/699#discussion_r2587203958
##########
fesod/src/main/java/org/apache/fesod/sheet/FastExcelFactory.java:
##########
@@ -20,11 +20,56 @@
package org.apache.fesod.sheet;
/**
- * An alias class for {@link FesodSheet}.
- * This class is deprecated; use {@link FesodSheet} instead.
- * <p>
- * This class will be removed in future versions.
- * </p>
+ * Legacy factory class alias for {@link FesodSheet}.
+ *
+ * <p><strong>DEPRECATED:</strong> This class has been deprecated as part of the project's evolution
+ * from "FastExcel" to "Apache Fesod". Users should migrate to {@link FesodSheet} for all new development.
+ *
+ * <h3>Migration Guide</h3>
+ * <p>Replace all occurrences of {@code FastExcelFactory} with {@code FesodSheet} in your codebase:
+ *¡
+ * <table border="1">
+ * <caption>Migration Examples</caption>
+ * <tr>
+ * <th>Old Code (Deprecated)</th>
+ * <th>New Code (Recommended)</th>¡
Review Comment:
There's an unnecessary inverted exclamation mark (¡) character at the end of this line. This appears to be a typographical error.
```suggestion
* <th>New Code (Recommended)</th>
```
##########
fesod/src/main/java/org/apache/fesod/sheet/FastExcelFactory.java:
##########
@@ -20,11 +20,56 @@
package org.apache.fesod.sheet;
/**
- * An alias class for {@link FesodSheet}.
- * This class is deprecated; use {@link FesodSheet} instead.
- * <p>
- * This class will be removed in future versions.
- * </p>
+ * Legacy factory class alias for {@link FesodSheet}.
+ *
+ * <p><strong>DEPRECATED:</strong> This class has been deprecated as part of the project's evolution
+ * from "FastExcel" to "Apache Fesod". Users should migrate to {@link FesodSheet} for all new development.
+ *
+ * <h3>Migration Guide</h3>
+ * <p>Replace all occurrences of {@code FastExcelFactory} with {@code FesodSheet} in your codebase:
+ *¡
+ * <table border="1">
+ * <caption>Migration Examples</caption>
+ * <tr>
+ * <th>Old Code (Deprecated)</th>
+ * <th>New Code (Recommended)</th>¡
Review Comment:
There's an unnecessary inverted exclamation mark (¡) character at the end of this line. This appears to be a typographical error.
```suggestion
*
* <table border="1">
* <caption>Migration Examples</caption>
* <tr>
* <th>Old Code (Deprecated)</th>
* <th>New Code (Recommended)</th>
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] javadoc: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 closed pull request #699: javadoc: Deprecate legacy classes and add migration guidance to FesodSheet
URL: https://github.com/apache/fesod/pull/699
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3556093552
> @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?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "delei (via GitHub)" <gi...@apache.org>.
delei commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3556030851
:confused: 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3567457344
@psxjoy PTAL
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "delei (via GitHub)" <gi...@apache.org>.
delei commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3557341560
> 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`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3556067444
@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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org
Re: [PR] refactor: Deprecate legacy classes and add migration guidance to FesodSheet [fesod]
Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3557547149
> > 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?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org