Skip to content

Commit d32d025

Browse files
authored
DOC: add backticks to docstrings (#54030)
add backticks to docstrings
1 parent fad7abc commit d32d025

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

pandas/io/xml.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
:mod:`pandas.io.xml` is a module for reading XML.
2+
:mod:``pandas.io.xml`` is a module for reading XML.
33
"""
44

55
from __future__ import annotations
@@ -66,26 +66,26 @@ class _XMLFrameParser:
6666
6767
Parameters
6868
----------
69-
path_or_buffer : a valid JSON str, path object or file-like object
69+
path_or_buffer : a valid JSON ``str``, path object or file-like object
7070
Any valid string path is acceptable. The string could be a URL. Valid
7171
URL schemes include http, ftp, s3, and file.
7272
7373
xpath : str or regex
7474
The XPath expression to parse required set of nodes for
75-
migration to `Data Frame`. `etree` supports limited XPath.
75+
migration to :class:`~pandas.DataFrame`. `etree` supports limited XPath.
7676
7777
namespaces : dict
78-
The namespaces defined in XML document (`xmlns:namespace='URI')
78+
The namespaces defined in XML document (``xmlns:namespace='URI'``)
7979
as dicts with key being namespace and value the URI.
8080
8181
elems_only : bool
82-
Parse only the child elements at the specified `xpath`.
82+
Parse only the child elements at the specified ``xpath``.
8383
8484
attrs_only : bool
85-
Parse only the attributes at the specified `xpath`.
85+
Parse only the attributes at the specified ``xpath``.
8686
8787
names : list
88-
Column names for Data Frame of parsed XML data.
88+
Column names for :class:`~pandas.DataFrame`of parsed XML data.
8989
9090
dtype : dict
9191
Data type for data or columns. E.g. {{'a': np.float64,

0 commit comments

Comments
 (0)