You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "Shivani622 (via GitHub)" <gi...@apache.org> on 2025/02/14 16:45:46 UTC
[PR] [Docs][C++] Adding some more Functions to API docs #45323 [arrow]
Shivani622 opened a new pull request, #45539:
URL: https://github.com/apache/arrow/pull/45539
<!--
Thanks for opening a pull request!
If this is your first pull request you can find detailed information on how
to contribute here:
* [New Contributor's Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request)
* [Contributing Overview](https://arrow.apache.org/docs/dev/developers/overview.html)
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes),
please open an issue first: https://github.com/apache/arrow/issues/new/choose
and reference it in the pull request title:
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
-->
### Rationale for this change
The primary motivation is to ensure consistency and clarity in the Compute Functions documentation. Previously, function categories were documented with bullet lists, while some other sections (like "Abstract Function classes" and "Function execution") used a .. doxygengroup:: style. By reorganizing all function categories to follow the same structure, we can provide a more uniform look and feel to the Arrow C++ docs, making them easier to navigate and maintain.
### What changes are included in this PR?
- Converted bullet-point lists (e.g., Arithmetic Functions, Boolean and Logical Functions, etc.) to use the .. doxygengroup:: directive.
- Grouped each function category under its own heading for better consistency with existing sections such as “Abstract Function classes” and “Function execution.”
- Added placeholders for each group’s content (e.g. :content-only:, :members:) so they can be populated by existing or future Doxygen groups.
- Minor edits to headings and reStructuredText syntax to align with the style used throughout the rest of the documentation.
### Are these changes tested?
- These are documentation-only changes. No new code or test files have been added.
### Are there any user-facing changes?
- *Yes*, but only in the presentation and organization of documentation. The functionality, APIs, or behavior of Arrow’s compute functions remain unchanged.
<!--
If there are any breaking changes to public APIs, please uncomment the line below and explain which changes are breaking.
-->
<!-- *This PR includes breaking changes to public APIs.* -->
<!--
If you fixed a security vulnerability or a critical bug, please uncomment and explain below.
-->
<!-- *This PR contains a "Critical Fix".* -->
--
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
Re: [PR] [Docs][C++] Adding some more Functions to API docs #45323 [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #45539:
URL: https://github.com/apache/arrow/pull/45539#issuecomment-2659807743
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
Thanks for opening a pull request!
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
Then could you also rename the pull request title in the following format?
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
See also:
* [Other pull requests](https://github.com/apache/arrow/pulls/)
* [Contribution Guidelines - Contributing Overview](https://arrow.apache.org/docs/developers/overview.html)
--
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
Re: [PR] GH-45540: [Docs][C++] Adding some more comute functions to API docs [arrow]
Posted by "pitrou (via GitHub)" <gi...@apache.org>.
pitrou commented on PR #45539:
URL: https://github.com/apache/arrow/pull/45539#issuecomment-2662432572
@github-actions crossbow submit preview-docs
--
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
Re: [PR] GH-45540: [Docs][C++] Adding some more compute functions to API docs [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #45539:
URL: https://github.com/apache/arrow/pull/45539#issuecomment-3958605942
Thank you for your contribution. Unfortunately, this pull request has been marked as stale because it has had no activity in the past 365 days. Please remove the stale label or comment below, or this PR will be closed in 14 days. Feel free to re-open this if it has been closed in error. If you do not have repository permissions to reopen the PR, please tag a maintainer.
--
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
Re: [PR] GH-45540: [Docs][C++] Adding some more comute functions to API docs [arrow]
Posted by "pitrou (via GitHub)" <gi...@apache.org>.
pitrou commented on PR #45539:
URL: https://github.com/apache/arrow/pull/45539#issuecomment-2662617807
Thanks @Shivani622 ! However, this didn't work because the `doxygengroup` directives must refer to actual Doxygen groups in the C++ docstrings. See error messages in this docs preview:
http://crossbow.voltrondata.com/pr_docs/45539/cpp/api/compute.html
(exemple: `doxygengroup: Cannot find group “compute-arithmetic” in doxygen xml output for project “arrow_cpp” from directory: /build/cpp/apidoc/xml`)
The solution would be to add Doxygen group definitions corresponding to the APIs that should go into each category.
You can find an example group definition here:
https://github.com/apache/arrow/blob/a53a77c93217399c4fda8c6328db2c492a30b0b0/cpp/src/arrow/type_fwd.h#L477-L480
It ends with a corresponding closing brace (`@}`):
https://github.com/apache/arrow/blob/a53a77c93217399c4fda8c6328db2c492a30b0b0/cpp/src/arrow/type_fwd.h#L685
--
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
Re: [PR] [Docs][C++] Adding some more Functions to API docs [arrow]
Posted by "Shivani622 (via GitHub)" <gi...@apache.org>.
Shivani622 closed pull request #45539: [Docs][C++] Adding some more Functions to API docs
URL: https://github.com/apache/arrow/pull/45539
--
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
Re: [PR] GH-45540: [Docs][C++] Adding some more comute functions to API docs [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #45539:
URL: https://github.com/apache/arrow/pull/45539#issuecomment-2662437536
Revision: c260b55dd4def02b24a4dd028a58c0b34d97832f
Submitted crossbow builds: [ursacomputing/crossbow @ actions-16a60b00c1](https://github.com/ursacomputing/crossbow/branches/all?query=actions-16a60b00c1)
|Task|Status|
|----|------|
|preview-docs|[](https://github.com/ursacomputing/crossbow/actions/runs/13366314812/job/37324770430)|
--
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
Re: [PR] GH-45540: [Docs][C++] Adding some more compute functions to API docs [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #45539: GH-45540: [Docs][C++] Adding some more compute functions to API docs
URL: https://github.com/apache/arrow/pull/45539
--
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
Re: [PR] GH-45540: [Docs][C++] Adding some more Functions to API docs [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #45539:
URL: https://github.com/apache/arrow/pull/45539#issuecomment-2661180166
:warning: GitHub issue #45540 **has been automatically assigned in GitHub** to PR creator.
--
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