alamb opened a new pull request, #245:
URL: https://github.com/apache/parquet-format/pull/245

   https://issues.apache.org/jira/browse/PARQUET-2480
   
   I have always found it very confusing that people refer to the term "page 
index" when referring to parquet, for example [this 
message](https://lists.apache.org/thread/o9nxbmv1z4hph3v5s2z63jsklywpkyyj,)
   
   However, the term "page index" is not used in the the 
[parquet.thrift](https://github.com/apache/parquet-format/blob/master/src/main/thrift/parquet.thrift)
 file itself, but only appears as the name of the file that describes the 
`ColumnIndex` spec, 
[PageIndex.md](https://github.com/apache/parquet-format/blob/master/PageIndex.md)
   
   This means I can't search for "page index" in the spec and find out what 
people are talking about
   
   ## Proposed Clarifications
   1. Update the introductory paragraph of `PageIndex.md` to clarify use the 
term "page index" and explain that it is encoded as ColumnIndex
   2. Update the description of `ColumnIndex` to include the term "page index" 
and clarify what it is
   
   
   
   ### Jira
   
   - [x] My PR addresses the following [Parquet 
Jira](https://issues.apache.org/jira/browse/PARQUET/) issues and references 
them in the PR title. For example, "PARQUET-1234: My Parquet PR"
     - https://issues.apache.org/jira/browse/PARQUET-2480
     - In case you are adding a dependency, check if the license complies with 
the [ASF 3rd Party License 
Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### Commits
   
   - [x] My commits all reference Jira issues in their subject lines. In 
addition, my commits follow the guidelines from "[How to write a good git 
commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [x] In case of new functionality, my PR adds documentation that describes 
how to use it.
     - All the public functions and the classes in the PR contain Javadoc that 
explain what it does
   


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


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to