[GitHub] [arrow] pitrou edited a comment on pull request #7695: ARROW-8989: [C++][Doc] Document available compute functions

[GitBox <gi...@apache.org>]

pitrou edited a comment on pull request #7695:
URL: https://github.com/apache/arrow/pull/7695#issuecomment-657467563


   So there are three formats to choose from:
   * "full" reST table layout:
   ```restructuredtext
   +--------------------------+------------+---------------------------------------------+---------------------+
   | Function names           | Arity      | Input types                                 | Output type         |
   +==========================+============+=============================================+=====================+
   | equal, not_equal         | Binary     | Numeric, Temporal, Binary- and String-like  | Boolean             |
   +--------------------------+------------+---------------------------------------------+---------------------+
   | greater, greater_equal,  | Binary     | Numeric, Temporal, Binary- and String-like  | Boolean             |
   | less, less_equal         |            |                                             |                     |
   +--------------------------+------------+---------------------------------------------+---------------------+
   ```
   
   * "simplified" reST table layout:
   ```restructuredtext
   ========================================= =========== ============================================== =================
   Function names                            Arity       Input types                                    Output type
   ========================================= =========== ============================================== =================
   equal, not_equal                          Binary      Numeric, Temporal, Binary- and String-like     Boolean
   greater, greater_equal, less, less_equal  Binary      Numeric, Temporal, Binary- and String-like     Boolean
   ========================================= =========== ============================================== =================
   ```
   
   * list table layout:
   ```restructuredtext
   .. list-table::
      :header-rows: 1
   
      * - Function names
        - Arity
        - Input types
        - Output type
      * - equal, not_equal
        - Binary
        - Numeric, Temporal, Binary- and String-like
        - Boolean
      * - greater, greater_equal, less, less_equal
        - Binary
        - Numeric, Temporal, Binary- and String-like
        - Boolean
   ```
   
   The simplified table layout doesn't allow multi-line cells or cell fusion. It's also not much easier to edit than full table layout.
   
   The list table layout isn't easily reviewable in source format, you have to build the docs to see clearly what happens. And it will get quite unwieldy if you have 10 rows instead of 3 here.
   
   Personally, I would favour the full table layout. Mostly you need to get used to it.
   


----------------------------------------------------------------
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:
users@infra.apache.org