-
Notifications
You must be signed in to change notification settings - Fork 74
#1036: Deprecated unused mimetypes argument in ResourcesServices #1465
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
Conversation
|
@ehennum Curious if you have any thoughts on the approach of deprecating this in |
BillFarber
left a comment
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.
I think you must have enjoyed removing all that code.
|
Going to keep this open until @ehennum can weigh in on the deprecate vs remove-because-bugfix approach |
02d93df to
b1533f6
Compare
ehennum
left a comment
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.
Good to finalize this cleanup!
|
@ehennum Thoughts though on deprecate vs remove? I think there's an argument for remove without first deprecating it:
|
|
@rjrudin, I see belatedly that the current documentation doesn't deprecate the mimetypes parameter: https://docs.marklogic.com/javadoc/client/index.html?overview-summary.html In general, I believe the preferred approach is to document the deprecation and remove on the next release cycle to give adopters time to change their code. In the specific case, given that the parameter is a noop, removing it wouldn't remove any functionality. So, the concern would be limited to forcing people to change their code and recompile if they are using the noop. Given that the change is so straightforward, the argument could be made that there's no good reason for adopters to defer the fix during a deprecation period. |
Was able to remove this completely in OkHttpServices, as the argument wasn't used for anything. But can't remove it from ResourceServices since that's a public interface. So deprecating the argument in the 6 methods that have it. Adjusted each test and example not to pass in a mimetype argument anymore; those were misleading since it implied that the argument was having some impact.
b1533f6 to
d9aa09c
Compare
Was able to remove this completely in OkHttpServices, as the argument wasn't used for anything. But can't remove it from ResourceServices since that's a public interface. So deprecating the argument in the 6 methods that have it.
Adjusted each test and example not to pass in a mimetype argument anymore; those were misleading since it implied that the argument was having some impact.