Skip to content

DOC: add backticks to docstrings #54030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2023
Merged

DOC: add backticks to docstrings #54030

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions pandas/io/xml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
:mod:`pandas.io.xml` is a module for reading XML.
:mod:``pandas.io.xml`` is a module for reading XML.
"""

from __future__ import annotations
Expand Down Expand Up @@ -66,26 +66,26 @@ class _XMLFrameParser:

Parameters
----------
path_or_buffer : a valid JSON str, path object or file-like object
path_or_buffer : a valid JSON ``str``, path object or file-like object
Any valid string path is acceptable. The string could be a URL. Valid
URL schemes include http, ftp, s3, and file.

xpath : str or regex
The XPath expression to parse required set of nodes for
migration to `Data Frame`. `etree` supports limited XPath.
migration to :class:`~pandas.DataFrame`. `etree` supports limited XPath.

namespaces : dict
The namespaces defined in XML document (`xmlns:namespace='URI')
The namespaces defined in XML document (``xmlns:namespace='URI'``)
as dicts with key being namespace and value the URI.

elems_only : bool
Parse only the child elements at the specified `xpath`.
Parse only the child elements at the specified ``xpath``.

attrs_only : bool
Parse only the attributes at the specified `xpath`.
Parse only the attributes at the specified ``xpath``.

names : list
Column names for Data Frame of parsed XML data.
Column names for :class:`~pandas.DataFrame`of parsed XML data.

dtype : dict
Data type for data or columns. E.g. {{'a': np.float64,
Expand Down