diff --git a/slep009/proposal.rst b/slep009/proposal.rst index c6f8cb0..248c21f 100644 --- a/slep009/proposal.rst +++ b/slep009/proposal.rst @@ -17,7 +17,7 @@ This proposal discusses the path to gradually forcing users to pass arguments, or most of them, as keyword arguments only. It talks about the status-quo, and the motivation to introduce the change. It shall cover the pros and cons of the change. The original issue starting the discussion is located -`here `_. +`here `__. Motivation ########## @@ -110,8 +110,8 @@ following two definitions may also be confusing to some users: However, some other teams are already moving towards using the syntax, such as ``matplotlib`` which has introduced the syntax with a deprecation cycle using a decorator for this purpose in version 3.1. The related PRs can be found `here -`_ and `here -`_. Soon users will be +`__ and `here +`__. Soon users will be familiar with the syntax. IDE Support @@ -151,7 +151,7 @@ An important open question is which functions/methods and/or parameters should follow this pattern, and which parameters should be keyword only. We can identify the following categories of functions/methods: -- ``__init__``s +- ``__init__`` - Main methods of the API, *i.e.* ``fit``, ``transform``, etc. - All other methods, *e.g.* ``SpectralBiclustering.get_submatrix`` - Functions @@ -168,8 +168,8 @@ defined as either of the following two ways: the *easy* cases. - A set identified as being in the top 95% of the use cases, using some automated analysis such as `this one - `_ or `this one - `_. + `__ or `this one + `__. This way we would minimize the number of warnings the users would receive, which minimizes the friction cause by the change. This SLEP does not define