mrkartik00 opened a new pull request, #4338:
URL: https://github.com/apache/gravitino/pull/4338

   I added @Deprecated annotations to relevant methods in the 
GravitinoClientBase class to improve code clarity and guide developers towards 
using updated methods.   - Deprecated `getVersion()` method in favor of 
`serverVersion()`. - Provided explanations within the annotations to clarify 
why the deprecation was applied and what should be used instead.  This change 
ensures that outdated methods are clearly marked and helps maintain codebase 
consistency.  Closes #3084
   
   As part of an effort to keep the Gravitino Java client codebase clean and 
up-to-date, deprecated annotations were added to certain methods in the 
GravitinoClientBase class. The `getVersion()` method was marked as deprecated 
since it duplicates the functionality provided by the `serverVersion()` method. 
An inline comment was provided to guide developers towards using the 
recommended method.
   
   This is my first contribution to the project, and I look forward to 
contributing further. Please review the changes and provide feedback if needed.
   
   ### What changes were proposed in this pull request?
   
   This pull request adds @Deprecated annotations to specific methods within 
the GravitinoClientBase class. The getVersion() method was deprecated in favor 
of serverVersion() to reduce redundancy and steer developers towards the 
preferred method. Each deprecated method includes a detailed comment explaining 
why the deprecation was applied and suggesting the appropriate alternative.
   
   ### Why are the changes needed?
   
   These changes are necessary to maintain a clean and up-to-date codebase. By 
marking certain methods as deprecated, we help developers avoid using outdated 
or redundant methods and encourage best practices within the Gravitino Java 
client. Specifically:
   
   The getVersion() method was deprecated as it duplicates the functionality of 
serverVersion().
   Developers are now guided to use the recommended methods via inline comments.
   
   Fix: #3084
   
   ### Does this PR introduce any  user-facing change?
   
   There are no direct user-facing changes. However, developers using the 
GravitinoClientBase class will now see deprecated warnings for certain methods, 
guiding them towards the recommended alternatives.
   
   ### How was this patch tested?
   The patch was tested by running the existing unit tests to ensure that the 
addition of @Deprecated annotations did not introduce any regressions or break 
existing functionality. No new tests were required, as this change is purely 
annotative and does not alter the underlying logic.
   


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to