Skip to content

Commit 1d57fe0

Browse files
authored
Fix ReST errors in SLEP009 (#41)
1 parent 0fa0b53 commit 1d57fe0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

slep009/proposal.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This proposal discusses the path to gradually forcing users to pass arguments,
1717
or most of them, as keyword arguments only. It talks about the status-quo, and
1818
the motivation to introduce the change. It shall cover the pros and cons of the
1919
change. The original issue starting the discussion is located
20-
`here <https://github.com/scikit-learn/scikit-learn/issues/12805>`_.
20+
`here <https://github.com/scikit-learn/scikit-learn/issues/12805>`__.
2121

2222
Motivation
2323
##########
@@ -110,8 +110,8 @@ following two definitions may also be confusing to some users:
110110
However, some other teams are already moving towards using the syntax, such as
111111
``matplotlib`` which has introduced the syntax with a deprecation cycle using a
112112
decorator for this purpose in version 3.1. The related PRs can be found `here
113-
<https://github.com/matplotlib/matplotlib/pull/13601>`_ and `here
114-
<https://github.com/matplotlib/matplotlib/pull/14130>`_. Soon users will be
113+
<https://github.com/matplotlib/matplotlib/pull/13601>`__ and `here
114+
<https://github.com/matplotlib/matplotlib/pull/14130>`__. Soon users will be
115115
familiar with the syntax.
116116

117117
IDE Support
@@ -151,7 +151,7 @@ An important open question is which functions/methods and/or parameters should
151151
follow this pattern, and which parameters should be keyword only. We can
152152
identify the following categories of functions/methods:
153153
154-
- ``__init__``s
154+
- ``__init__``
155155
- Main methods of the API, *i.e.* ``fit``, ``transform``, etc.
156156
- All other methods, *e.g.* ``SpectralBiclustering.get_submatrix``
157157
- Functions
@@ -168,8 +168,8 @@ defined as either of the following two ways:
168168
the *easy* cases.
169169
- A set identified as being in the top 95% of the use cases, using some
170170
automated analysis such as `this one
171-
<https://odyssey.readthedocs.io/en/latest/tutorial.html>`_ or `this one
172-
<https://github.com/Quansight-Labs/python-api-inspect>`_.
171+
<https://odyssey.readthedocs.io/en/latest/tutorial.html>`__ or `this one
172+
<https://github.com/Quansight-Labs/python-api-inspect>`__.
173173
174174
This way we would minimize the number of warnings the users would receive,
175175
which minimizes the friction cause by the change. This SLEP does not define

0 commit comments

Comments
 (0)