Skip to content

GH-50257: [CI][Docs] Fix doxygen failing due to double backticks#50259

Open
raulcd wants to merge 1 commit into
apache:mainfrom
raulcd:GH-50257
Open

GH-50257: [CI][Docs] Fix doxygen failing due to double backticks#50259
raulcd wants to merge 1 commit into
apache:mainfrom
raulcd:GH-50257

Conversation

@raulcd

@raulcd raulcd commented Jun 25, 2026

Copy link
Copy Markdown
Member

Rationale for this change

Doxygen is currently failing on main

What changes are included in this PR?

Remove double backticks because they trip doxygen.

Are these changes tested?

I have tested them locally with:
archery docker run conda-python-docs

Without the change I could reproduce the CI issue. With the change the job is successful.

Are there any user-facing changes?

No

@raulcd raulcd requested a review from pitrou as a code owner June 25, 2026 13:14
Copilot AI review requested due to automatic review settings June 25, 2026 13:14
@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #50257 has been automatically assigned in GitHub to PR creator.

@raulcd raulcd requested review from AntoinePrv and removed request for Copilot and pitrou June 25, 2026 13:14
@github-actions github-actions Bot added the awaiting committer review Awaiting committer review label Jun 25, 2026
@pitrou

pitrou commented Jun 25, 2026

Copy link
Copy Markdown
Member

@AntoinePrv FYI

@pitrou pitrou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it fixes the CI then good 🤷

@raulcd

raulcd commented Jun 25, 2026

Copy link
Copy Markdown
Member Author

@pitrou let's not merge yet, this fixed doxygen but I think the docs job still fail due to the last PR merged also breaking docs:

I can see some doctest failures locally now that the job has run to completion:

/opt/conda/envs/arrow/lib/python3.10/site-packages/pyarrow/lib.cpython-310-x86_64-linux-gnu.so:5953: DocTestFailure
____________________________________________________________________________________________ [doctest] pyarrow.lib.table _____________________________________________________________________________________________
6107 -- schema metadata --
6108 n_legs: 'Number of legs per animal'
6109 
6110 Construct a Table from pandas DataFrame:
6111 
6112 >>> import pandas as pd
6113 >>> df = pd.DataFrame({'year': [2020, 2022, 2019, 2021],
6114 ...                    'n_legs': [2, 4, 5, 100],
6115 ...                    'animals': ["Flamingo", "Horse", "Brittle stars", "Centipede"]})
6116 >>> pa.table(df)
Differences (unified diff with -expected +actual):
    @@ -2,5 +2,5 @@
     year: int64
     n_legs: int64
    -animals: large_string
    +animals: string
     ----
     year: [[2020,2022,2019,2021]]

@raulcd

raulcd commented Jun 25, 2026

Copy link
Copy Markdown
Member Author

It seems to be passing on CI and not related to the issue I pointed. It might be a stale local environment from my side. As I can't reproduce on CI, I think we can ignore my local failure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants