You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@arrow.apache.org by "zfoobar (via GitHub)" <gi...@apache.org> on 2023/04/16 22:12:38 UTC

[GitHub] [arrow] zfoobar opened a new issue, #35167: [Documentation] method signature incorrect in docs for JSON TableReader

zfoobar opened a new issue, #35167:
URL: https://github.com/apache/arrow/issues/35167

   ### Describe the bug, including details regarding any error messages, version, and platform.
   
   The argument count appears wrong in docs for for the JSON table reader object..
   
   [docs](https://arrow.apache.org/docs/cpp/json.htmlrl): 
   
   ```c++
   st = arrow::json::TableReader::Make(pool, input, read_options,
   parse_options, **&reader)**;
   ```
   
   object signature in json/reader.cc:
   
   ```c++
   Result<std::shared_ptr<TableReader>> TableReader::Make(
   MemoryPool* pool, std::shared_ptr<io::InputStream> input,
    const ReadOptions& read_options, const ParseOptions& parse_options)
   ```
   
   
   ### Component(s)
   
   C++


-- 
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: issues-unsubscribe@arrow.apache.org.apache.org

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


[GitHub] [arrow] rajatsmukherjee commented on issue #35167: [Docs] Make signature incorrect in docs for JSON TableReader

Posted by "rajatsmukherjee (via GitHub)" <gi...@apache.org>.
rajatsmukherjee commented on issue #35167:
URL: https://github.com/apache/arrow/issues/35167#issuecomment-1687650339

   Hi @westonpace , I am new to this and would like to take this up.


-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow] rsm-23 commented on issue #35167: [Docs] Make signature incorrect in docs for JSON TableReader

Posted by "rsm-23 (via GitHub)" <gi...@apache.org>.
rsm-23 commented on issue #35167:
URL: https://github.com/apache/arrow/issues/35167#issuecomment-1687794342

   take


-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow] rsm-23 commented on issue #35167: [Docs] Make signature incorrect in docs for JSON TableReader

Posted by "rsm-23 (via GitHub)" <gi...@apache.org>.
rsm-23 commented on issue #35167:
URL: https://github.com/apache/arrow/issues/35167#issuecomment-1687859907

   @westonpace I have created a PR for the above. Can you please review 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.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow] Tej-ashwani commented on issue #35167: [Docs] Make signature incorrect in docs for JSON TableReader

Posted by "Tej-ashwani (via GitHub)" <gi...@apache.org>.
Tej-ashwani commented on issue #35167:
URL: https://github.com/apache/arrow/issues/35167#issuecomment-1571830505

   Result<std::shared_ptr<TableReader>> TableReader::Make(
       MemoryPool* pool, std::shared_ptr<io::InputStream> input,
       const ReadOptions& read_options, const ParseOptions& parse_options)
   
   Based on the information provided, the bug seems to be related to the argument count discrepancy in the documentation for the TableReader::Make method in the json/reader.cc file.
   
   However, the bug report suggests that the argument count appears wrong in the documentation for this method.
   
   It is important to note that without further details, such as the specific error messages, version of the software/library, and platform where the bug is encountered, it is difficult to provide a more specific analysis or solution. Additionally, if there is an inconsistency between the documentation and the actual API, it might be necessary to refer to the API documentation or consult the library's developers for clarification.
   
   
   
   
   
   Send a message.
   
   
   
   


-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow] westonpace commented on issue #35167: [Docs] Make signature incorrect in docs for JSON TableReader

Posted by "westonpace (via GitHub)" <gi...@apache.org>.
westonpace commented on issue #35167:
URL: https://github.com/apache/arrow/issues/35167#issuecomment-1584928239

   Yes, you are correct.  There was a [change](https://github.com/apache/arrow/pull/7646/files) a while back from a status-returning method with an out-parameter to a result-returning method.
   
   The [example in the docs](https://github.com/apache/arrow/blob/main/docs/source/cpp/json.rst?plain=1) will need to be updated.
   
   Would you be interested in submitting a PR?


-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow] kou closed issue #35167: [Docs] Make signature incorrect in docs for JSON TableReader

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou closed issue #35167: [Docs] Make signature incorrect in docs for JSON TableReader 
URL: https://github.com/apache/arrow/issues/35167


-- 
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: issues-unsubscribe@arrow.apache.org

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


[GitHub] [arrow] rajatsmukherjee commented on issue #35167: [Docs] Make signature incorrect in docs for JSON TableReader

Posted by "rajatsmukherjee (via GitHub)" <gi...@apache.org>.
rajatsmukherjee commented on issue #35167:
URL: https://github.com/apache/arrow/issues/35167#issuecomment-1687651059

   take


-- 
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: github-unsubscribe@arrow.apache.org

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