mocobeta opened a new pull request #130:
URL: https://github.com/apache/lucene/pull/130


   (Maybe) trivial documentation change. Current format description of 
[TermVectorsFormat](https://lucene.apache.org/core/8_8_2/core/org/apache/lucene/codecs/lucene50/Lucene50TermVectorsFormat.html)
 is a little bit hard to understand because various information (datatypes and 
explanation) is mixed up in the same line. 
   It could be improved if it is reorganized in a similar way to 
[PostingsFormat](https://lucene.apache.org/core/8_8_1/core/org/apache/lucene/codecs/lucene84/Lucene84PostingsFormat.html);
 the datatypes and additional information are strictly separated there.
   
   Screenshot of the reorganized javadoc with this pr:
   
![termvectorsformat_refined_javadoc](https://user-images.githubusercontent.com/1825333/117485705-aeac7580-afa3-11eb-9d39-14166bc7a077.png)
   
   Some type information was added when possible. No information was removed.


-- 
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.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org

Reply via email to