Skip to content
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] Function execution section missing from compute API reference #35438

Closed
drin opened this issue May 4, 2023 · 7 comments · Fixed by #35549
Closed

[Docs] Function execution section missing from compute API reference #35438

drin opened this issue May 4, 2023 · 7 comments · Fixed by #35549

Comments

@drin
Copy link
Contributor

drin commented May 4, 2023

Describe the bug, including details regarding any error messages, version, and platform.

I see a doxygen warning, and an empty function execution section.

Missing section (or maybe just empty?):

https://arrow.apache.org/docs/cpp/api/compute.html#function-execution

doxygen warning:

doxygengroup: Cannot find group “compute-functions-executor” in doxygen xml output for project “arrow_cpp” from directory: ../../cpp/apidoc/xml

The docs are for version 12.0.0, but oddly enough I can't change the version of the docs (the dropdown doesn't do anything).

I haven't validated the bug or triaged, but wanted to at least file for now.

Component(s)

Documentation, Website

@drin
Copy link
Contributor Author

drin commented May 4, 2023

Also, not sure if relevant, but the src attribute for the logo is incorrect:

<a class="navbar-brand" href="../../index.html">
  <img src="../../_static/../../_static/arrow.png" class="logo" alt="logo">
</a>

and I am seeing the following issues in the browser (firefox) console:

Uncaught ReferenceError: $ is not defined
    <anonymous> https://arrow.apache.org/docs/cpp/api/compute.html#function-execution:133
    <anonymous> https://arrow.apache.org/docs/cpp/api/compute.html#function-execution:151
    ...
Uncaught ReferenceError: jQuery is not defined
    <anonymous> https://arrow.apache.org/docs/_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf:1
    n https://arrow.apache.org/docs/_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf:1
    ...
Uncaught ReferenceError: $ is not defined
    <anonymous> https://arrow.apache.org/docs/_static/versionwarning.js:21
    <anonymous> https://arrow.apache.org/docs/_static/versionwarning.js:135

@AlenkaF
Copy link
Member

AlenkaF commented May 9, 2023

Yeah, the first one is a bug or better a typo. The correct group for doxygen is compute-function-executor (without an "s"). It will be corrected in #35486 (b973d8e#diff-9f736d28913127c4be6a02ccd78ef2559880eb900ad25ca0c1bb8c53bd03462d)

As for the logo issue, I think it was solved in #35405

@jorisvandenbossche
Copy link
Member

@AlenkaF feel free to do a quick MINOR PR to already fix the typo (the more we can leave out of #35486 the better, I think, given that's already a big diff and will still take some time to get merged)

@AlenkaF
Copy link
Member

AlenkaF commented May 11, 2023

I am thinking of adding most of the formatting corrections from this commit into one PR and link it to this issue. Would that be ok with everybody involved?

@jorisvandenbossche jorisvandenbossche changed the title [Website][Docs] Function execution section missing from compute API reference [Docs] Function execution section missing from compute API reference May 11, 2023
@jorisvandenbossche
Copy link
Member

Yes, that would be good

@westonpace
Copy link
Member

compute-functions-executor is changing in #35320 as well (just to make it more confusing). I will address the feedback on #35320 today and try and get that through.

@AlenkaF
Copy link
Member

AlenkaF commented May 11, 2023

Oh sorry, didn't realise that. Thank you for the info!

raulcd pushed a commit that referenced this issue May 16, 2023
This PR adds corrections to the source docs to remove some of the warnings when building the documentation.
* Closes: #35438

Authored-by: Alenka Frim <frim.alenka@gmail.com>
Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
@raulcd raulcd added this to the 13.0.0 milestone May 16, 2023
rtpsw pushed a commit to rtpsw/arrow that referenced this issue May 16, 2023
)

This PR adds corrections to the source docs to remove some of the warnings when building the documentation.
* Closes: apache#35438

Authored-by: Alenka Frim <frim.alenka@gmail.com>
Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants