danepitkin commented on PR #34894:
URL: https://github.com/apache/arrow/pull/34894#issuecomment-1500555404
One interesting limitation is if there are docstrings that use curly braces
`{}`. If it's a doctest, we would need to replace `{}` with an equivalent like
`dict()` or `set()`. If it's part of the descriptions, it can be escaped e.g.
`{{}}`
example:
```
Examples
--------
>>> import pyarrow as pa
>>> import pandas as pd
>>> df = pd.DataFrame({'year': [2020, 2022, 2019, 2021],
... 'n_legs': [2, 4, 5, 100],
... 'animals': ["Flamingo", "Horse", "Brittle
stars", "Centipede"]})
```
vs.
```
Examples
--------
>>> import pyarrow as pa
>>> import pandas as pd
>>> df = pd.DataFrame(dict('year': [2020, 2022, 2019, 2021],
... 'n_legs': [2, 4, 5, 100],
... 'animals': ["Flamingo", "Horse", "Brittle
stars", "Centipede"]))
```
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
