-
-
Notifications
You must be signed in to change notification settings - Fork 386
Removed ObsoleteAttribute from the old methods' signatures #858
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
Removed ObsoleteAttribute from the old methods' signatures #858
Conversation
…the AddPicture methods from the OpenXmlExporter to the OpenXmlTemplater
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.
Summary of Changes
Hello @michelebastione, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refines the API of the MiniExcel library by removing the 'ObsoleteAttribute' from many previously marked 'legacy' methods and attributes, signifying their continued support. Additionally, it logically relocates the 'AddPicture' functionality from the 'OpenXmlExporter' to the 'OpenXmlTemplater' class, improving the organization and appropriateness of the API design.
Highlights
- Deprecation Strategy Adjustment: The
ObsoleteAttribute
has been removed from a significant number of methods and attributes previously marked as 'legacy' in theMiniExcelLibs
namespace. This change suggests a re-evaluation of the API's deprecation strategy, making these methods and attributes fully supported parts of the public API, rather than being phased out in favor of 'Core' equivalents. TheQueryAsDataTableAsync
methods retain anObsoleteAttribute
, but its message has been updated to specifically warn about potential memory issues, clarifying the reason for its discouraged use. - Relocation of Picture Addition Methods: The
AddPicture
andAddPictureAsync
methods, which facilitate adding images to Excel files, have been relocated from theOpenXmlExporter
class to theOpenXmlTemplater
class. This move aligns the functionality with the templating capabilities, where image insertion is often a key requirement. Corresponding internal calls and test cases have been updated to reflect this change.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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.
Code Review
This pull request effectively removes the ObsoleteAttribute
from many legacy methods and correctly relocates the AddPicture
and AddPictureAsync
methods to the OpenXmlTemplater
class, which is a more logical home for them. The changes are consistent and the related tests have been updated to reflect this refactoring.
My review includes a suggestion to restore the XML documentation comments for the QueryAsDataTableAsync
methods. While the warning message was helpfully moved to the Obsolete
attribute, retaining the <summary>
tag is important for API documentation visibility in tools like IntelliSense.
ObsoleteAttribute
from the old methods' signatures as per discussed in New readme for v2.0 #855AddPicture
andAddPictureAsync
methods from theOpenXmlExporter
to the more appropriateOpenXmlTemplater