RFR(s): 8073923: Files.lines() documentation needs clarification

Stuart Marks stuart.marks at oracle.com
Wed Mar 4 22:16:56 UTC 2015


On 3/4/15 12:31 AM, Alan Bateman wrote:
> On 03/03/2015 23:05, Stuart Marks wrote:
>> Updated webrev:
>>
>>     http://cr.openjdk.java.net/~smarks/reviews/8073923/webrev.2/
> This looks good. Minor re-wording suggestions, ignore if you want:
>
> "... reference to an open XXX, which is closed by ..."
>    => "... reference to an open XXX. The XXX is closed by ..."

Yes. Reads a bit better this way.

> "to ensure that the stream's open XXX reference is closed"
>    => "to ensure that the XXX is closed".

I considered this but sometimes the earlier mention of the XXX was far enough 
away that it wasn't clear what this was talking about. I changed these 
essentially to "to ensure that the stream's open XXX is closed" which makes more 
sense, I think, since "closing a file" makes more sense than "closing a 
reference to a file."

I've made these changes and pushed the changeset. Thanks for the reviews.

s'marks



More information about the core-libs-dev mailing list