Skip to content

Commit bb94a72

Browse files
committed
DOC: Uniform block directive syntax.
block directive syntax technically does not have space before the double-colon. While this seem to be accepted by docutils – but not documented, this can throw off other RST parser/syntax highlighter. Sometime they can see that as comments, sometime they give garbage out. Plus this is really uncommon with 3 occurrences in pandas codebase with space and 4800 without: pandas[master] $ rg '\.\. \w+::' | wc -l 4853 Numpy and scipy used to have a few space in their block directive, but current master/main branch of both should also be free of directive with space before the double colon.
1 parent aee6b7a commit bb94a72

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

doc/source/user_guide/io.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -3546,9 +3546,9 @@ with ``on_demand=True``.
35463546
Specifying sheets
35473547
+++++++++++++++++
35483548

3549-
.. note :: The second argument is ``sheet_name``, not to be confused with ``ExcelFile.sheet_names``.
3549+
.. note:: The second argument is ``sheet_name``, not to be confused with ``ExcelFile.sheet_names``.
35503550

3551-
.. note :: An ExcelFile's attribute ``sheet_names`` provides access to a list of sheets.
3551+
.. note:: An ExcelFile's attribute ``sheet_names`` provides access to a list of sheets.
35523552

35533553
* The arguments ``sheet_name`` allows specifying the sheet or sheets to read.
35543554
* The default value for ``sheet_name`` is 0, indicating to read the first sheet

pandas/core/algorithms.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -633,7 +633,7 @@ def factorize(
633633
is a Categorical. When `values` is some other pandas object, an
634634
`Index` is returned. Otherwise, a 1-D ndarray is returned.
635635
636-
.. note ::
636+
.. note::
637637
638638
Even if there's a missing value in `values`, `uniques` will
639639
*not* contain an entry for it.

0 commit comments

Comments
 (0)