Skip to content

Commit 6a5a565

Browse files
datapythonistajreback
authored andcommitted
DOC: Fixing spaces around backticks, and linting (#21570)
1 parent 1c0740c commit 6a5a565

File tree

5 files changed

+17
-9
lines changed

5 files changed

+17
-9
lines changed

ci/lint.sh

+8
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,14 @@ if [ "$LINT" ]; then
174174
fi
175175
echo "Check for old-style classes DONE"
176176

177+
echo "Check for backticks incorrectly rendering because of missing spaces"
178+
grep -R --include="*.rst" -E "[a-zA-Z0-9]\`\`?[a-zA-Z0-9]" doc/source/
179+
180+
if [ $? = "0" ]; then
181+
RET=1
182+
fi
183+
echo "Check for backticks incorrectly rendering because of missing spaces DONE"
184+
177185
else
178186
echo "NOT Linting"
179187
fi

doc/source/merging.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -279,9 +279,9 @@ need to be:
279279

280280
Ignoring indexes on the concatenation axis
281281
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
282-
For ``DataFrame``s which don't have a meaningful index, you may wish to append
283-
them and ignore the fact that they may have overlapping indexes. To do this, use
284-
the ``ignore_index`` argument:
282+
For ``DataFrame`` objects which don't have a meaningful index, you may wish
283+
to append them and ignore the fact that they may have overlapping indexes. To
284+
do this, use the ``ignore_index`` argument:
285285

286286
.. ipython:: python
287287
@@ -314,7 +314,7 @@ This is also a valid argument to :meth:`DataFrame.append`:
314314
Concatenating with mixed ndims
315315
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
316316

317-
You can concatenate a mix of ``Series`` and ``DataFrame``s. The
317+
You can concatenate a mix of ``Series`` and ``DataFrame`` objects. The
318318
``Series`` will be transformed to ``DataFrame`` with the column name as
319319
the name of the ``Series``.
320320

doc/source/release.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -2641,7 +2641,7 @@ Improvements to existing features
26412641
option it is no longer possible to round trip Excel files with merged
26422642
MultiIndex and Hierarchical Rows. Set the ``merge_cells`` to ``False`` to
26432643
restore the previous behaviour. (:issue:`5254`)
2644-
- The FRED DataReader now accepts multiple series (:issue`3413`)
2644+
- The FRED DataReader now accepts multiple series (:issue:`3413`)
26452645
- StataWriter adjusts variable names to Stata's limitations (:issue:`5709`)
26462646

26472647
API Changes
@@ -2837,7 +2837,7 @@ API Changes
28372837
copy through chained assignment is detected, settable via option ``mode.chained_assignment``
28382838
- test the list of ``NA`` values in the csv parser. add ``N/A``, ``#NA`` as independent default
28392839
na values (:issue:`5521`)
2840-
- The refactoring involving``Series`` deriving from ``NDFrame`` breaks ``rpy2<=2.3.8``. an Issue
2840+
- The refactoring involving ``Series`` deriving from ``NDFrame`` breaks ``rpy2<=2.3.8``. an Issue
28412841
has been opened against rpy2 and a workaround is detailed in :issue:`5698`. Thanks @JanSchulz.
28422842
- ``Series.argmin`` and ``Series.argmax`` are now aliased to ``Series.idxmin`` and ``Series.idxmax``.
28432843
These return the *index* of the min or max element respectively. Prior to 0.13.0 these would return

doc/source/reshaping.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ When a column contains only one level, it will be omitted in the result.
654654
pd.get_dummies(df, drop_first=True)
655655
656656
By default new columns will have ``np.uint8`` dtype.
657-
To choose another dtype, use the``dtype`` argument:
657+
To choose another dtype, use the ``dtype`` argument:
658658

659659
.. ipython:: python
660660

doc/source/timeseries.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -2169,8 +2169,8 @@ still considered to be equal even if they are in different time zones:
21692169
rng_berlin[5]
21702170
rng_eastern[5] == rng_berlin[5]
21712171
2172-
Like ``Series``, ``DataFrame``, and ``DatetimeIndex``, ``Timestamp``s can be converted to other
2173-
time zones using ``tz_convert``:
2172+
Like ``Series``, ``DataFrame``, and ``DatetimeIndex``; ``Timestamp`` objects
2173+
can be converted to other time zones using ``tz_convert``:
21742174

21752175
.. ipython:: python
21762176

0 commit comments

Comments
 (0)