You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "raulcd (via GitHub)" <gi...@apache.org> on 2026/06/25 13:14:16 UTC

[PR] GH-50257: [CI][Docs] Fix doxygen failing due to double backticks [arrow]

raulcd opened a new pull request, #50259:
URL: https://github.com/apache/arrow/pull/50259

   ### 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
   


-- 
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-50257: [CI][Docs] Fix doxygen failing due to double backticks [arrow]

Posted by "raulcd (via GitHub)" <gi...@apache.org>.
raulcd commented on PR #50259:
URL: https://github.com/apache/arrow/pull/50259#issuecomment-4799873492

   @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:
   - https://github.com/apache/arrow/pull/50160
   
   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]]
   ```


-- 
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-50257: [CI][Docs] Fix doxygen failing due to double backticks [arrow]

Posted by "conbench-apache-arrow[bot] (via GitHub)" <gi...@apache.org>.
conbench-apache-arrow[bot] commented on PR #50259:
URL: https://github.com/apache/arrow/pull/50259#issuecomment-4814528364

   After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit ad31a1c62cafc3094171cc975e32457de9488150.
   
   There were no benchmark performance regressions. 🎉
   
   The [full Conbench report](https://github.com/apache/arrow/runs/83777870999) has more details.


-- 
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-50257: [CI][Docs] Fix doxygen failing due to double backticks [arrow]

Posted by "tadeja (via GitHub)" <gi...@apache.org>.
tadeja commented on PR #50259:
URL: https://github.com/apache/arrow/pull/50259#issuecomment-4809356839

   I've just confirmed locally that replacing double backticks with single backtics indeed allowed doxygen to complete, docs got built and `pytest -r s --doctest-modules --doctest-cython --pyargs pyarrow` passed for me. 👍 
   
   Just a note on that local doctest failure 
   >     -animals: large_string
   >     +animals: string
   It's because of pandas version pre 3.0 (which still allows python 3.10 ... but doctest CI job [got updated from](https://github.com/apache/arrow/pull/49088/changes#diff-092659a9bd0068791326fb1d08f005532e5aeb983b999a7bd32c51deee0a71d5R75) `conda-python-3.10` to `conda-python-3.11` as per Joris' https://github.com/apache/arrow/pull/49088#discussion_r2749993332:
   > FWIW, I think if we know the doctests will run on an instance with pandas>=3, I would just update those to use pandas 3 output, because that will be less confusing for people reading the docs ("what do those 3 dots mean here?").


-- 
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-50257: [CI][Docs] Fix doxygen failing due to double backticks [arrow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #50259:
URL: https://github.com/apache/arrow/pull/50259#issuecomment-4799653260

   :warning: GitHub issue #50257 **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


Re: [PR] GH-50257: [CI][Docs] Fix doxygen failing due to double backticks [arrow]

Posted by "raulcd (via GitHub)" <gi...@apache.org>.
raulcd commented on PR #50259:
URL: https://github.com/apache/arrow/pull/50259#issuecomment-4801271188

   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. 


-- 
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-50257: [CI][Docs] Fix doxygen failing due to double backticks [arrow]

Posted by "pitrou (via GitHub)" <gi...@apache.org>.
pitrou commented on PR #50259:
URL: https://github.com/apache/arrow/pull/50259#issuecomment-4799683500

   @AntoinePrv FYI


-- 
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-50257: [CI][Docs] Fix doxygen failing due to double backticks [arrow]

Posted by "rok (via GitHub)" <gi...@apache.org>.
rok merged PR #50259:
URL: https://github.com/apache/arrow/pull/50259


-- 
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