Skip to content

Conversation

@WarrenWeckesser
Copy link
Contributor

@WarrenWeckesser WarrenWeckesser commented Jul 23, 2025

count is in the doxygen group batch_reducers, and it shows up below the table of reduction operators along with reduce, reduce_add, etc., in the generated HTML, so it might as well be in the table.

Updated the PR so now count is moved to the 'Reducers' section of the batch-bool docs.

@serge-sans-paille
Copy link
Contributor

count is a batch_bool only operator, it would be good to make that explicit, maybe by using two tables, one for batch and one for batch_bool ?

@WarrenWeckesser
Copy link
Contributor Author

I don't know. I was originally looking for all and any reductions when I found this page and noticed that count was among the functions tagged as batch_reducers shown below the table but is not in the table.

I eventually found any and all in the Batch of conditions page. Perhaps count should be listed there.

@WarrenWeckesser
Copy link
Contributor Author

WarrenWeckesser commented Jul 23, 2025

Perhaps count should be listed there.

It looks like this can be done by moving count from the doxygen batch_reducers group to the batch_bool_reducers group. I'll undo my change to the table and make that group change instead. If I can figure out how to do a cross-reference with doxygen/sphinx, I'll add a "See also" note to the Reduction operations page.

@WarrenWeckesser WarrenWeckesser changed the title DOC: Add count to the table of reduction operations. DOC: Move 'count' to the batch-bool 'Reducers' section of the docs. Jul 23, 2025
@WarrenWeckesser
Copy link
Contributor Author

I pushed a new update. Now count will show up in the 'Reducers' section of the batch-bool docs. I also added a note in the 'Reduction operators' page (where count used to show up) that links to the batch-bool 'Reducers' docs.

@serge-sans-paille
Copy link
Contributor

Looks good, thanks!

@serge-sans-paille serge-sans-paille merged commit 631294a into xtensor-stack:master Jul 24, 2025
63 checks passed
@WarrenWeckesser WarrenWeckesser deleted the doc-reducers-table branch July 24, 2025 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants