-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs] Make signature incorrect in docs for JSON TableReader #35167
Comments
Result<std::shared_ptr> TableReader::Make( 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. |
Yes, you are correct. There was a change a while back from a status-returning method with an out-parameter to a result-returning method. The example in the docs will need to be updated. Would you be interested in submitting a PR? |
take |
@westonpace I have created a PR for the above. Can you please review it? |
### Rationale for this change The current document causes a build error. ### What changes are included in this PR? Use the current API. ### Are these changes tested? No. ### Are there any user-facing changes? Yes. * Closes: #35167 Lead-authored-by: Rajat Subhra Mukherjee <raromukherjee@gmail.com> Co-authored-by: Will Jones <willjones127@gmail.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
…pache#37301) ### Rationale for this change The current document causes a build error. ### What changes are included in this PR? Use the current API. ### Are these changes tested? No. ### Are there any user-facing changes? Yes. * Closes: apache#35167 Lead-authored-by: Rajat Subhra Mukherjee <raromukherjee@gmail.com> Co-authored-by: Will Jones <willjones127@gmail.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
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 method..
docs:
object signature in json/reader.cc:
It looks correct in the actual API docs.
Component(s)
C++
The text was updated successfully, but these errors were encountered: