On Thu, 27 Mar 2025 07:19:56 GMT, Jaikiran Pai <j...@openjdk.org> wrote:
> I spoke to Lance and we went over some possible ways to word the text for 
> these classes. Based on those inputs, I've now updated the PR. I think this 
> captures the necessary details and at the same time keeps it concise.

I realize the budget for wordsmithing is probably getting slim at this point. 
I'll still raise two issues, if they are within the budget to fix, that's good. 
However, I also understand if you just want to ship this :-)

* The term 'default compressor' may raise more questions than it answers. What 
is the default compressor, where is it specified, is it a shared instance, can 
it be configured or overridden? Perhaps 'internal compressor' is better here to 
signal that this is an internal implementation detail which needs no external 
attention except that close should be called (which the API note already 
mentions.)
* The note has two paragraphs. The first paragraph contains some contextual 
information which may aid understanding of the second paragraph . The second 
paragraph has the normative, important information. I feel the order of these 
two should be switched. Give the important, normative information first, then 
this can be followed up with an additional paragraph describing the 
no-compressor case.

-------------

PR Comment: https://git.openjdk.org/jdk/pull/23655#issuecomment-2757231292

Reply via email to