Skip to content

Commit 9b4204e

Browse files
committed
additional typos, formatting, and links for doc/developers/index and /utilities
1 parent 78e45fb commit 9b4204e

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

doc/developers/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ In addition, we add the following guidelines:
406406
that is implemented in ``sklearn.foo.bar.baz``,
407407
the test should import it from ``sklearn.foo``.
408408

409-
* **Please don't use ``import *`` in any case**. It is considered harmful
409+
* **Please don't use** ``import *`` **in any case**. It is considered harmful
410410
by the `official Python recommendations
411411
<http://docs.python.org/howto/doanddont.html#from-module-import>`_.
412412
It makes the code harder to read as the origin of symbols is no
@@ -859,7 +859,7 @@ All logic behind estimator parameters,
859859
like translating string arguments into functions, should be done in ``fit``.
860860

861861
Also it is expected that parameters with trailing ``_`` are **not to be set
862-
inside the** ``__init__`` **method. All and only the public attributes set by
862+
inside the** ``__init__`` **method**. All and only the public attributes set by
863863
fit have a trailing ``_``. As a result the existence of parameters with
864864
trailing ``_`` is used to check if the estimator has been fitted.
865865

doc/developers/utilities.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ efficiently process ``scipy.sparse`` data.
144144

145145
- :func:`sparsefuncs.inplace_csr_row_normalize_l1` and
146146
:func:`sparsefuncs.inplace_csr_row_normalize_l2`: can be used to normalize
147-
individual sparse samples to unit l1 or l2 norm as done in
147+
individual sparse samples to unit L1 or L2 norm as done in
148148
:class:`sklearn.preprocessing.Normalizer`.
149149

150150
- :func:`sparsefuncs.inplace_csr_column_scale`: can be used to multiply the
@@ -159,7 +159,8 @@ Graph Routines
159159
- :func:`graph.single_source_shortest_path_length`:
160160
(not currently used in scikit-learn)
161161
Return the shortest path from a single source
162-
to all connected nodes on a graph. Code is adapted from networkx.
162+
to all connected nodes on a graph. Code is adapted from `networkx
163+
<https://networkx.github.io/>`_.
163164
If this is ever needed again, it would be far faster to use a single
164165
iteration of Dijkstra's algorithm from ``graph_shortest_path``.
165166

@@ -169,7 +170,7 @@ Graph Routines
169170
both dense and sparse connectivity matrices.
170171

171172
- :func:`graph_shortest_path.graph_shortest_path`:
172-
(used in :class:``sklearn.manifold.Isomap``)
173+
(used in :class:`sklearn.manifold.Isomap`)
173174
Return the shortest path between all pairs of connected points on a directed
174175
or undirected graph. Both the Floyd-Warshall algorithm and Dijkstra's
175176
algorithm are available. The algorithm is most efficient when the
@@ -235,7 +236,7 @@ Testing Functions
235236
requests to mldata.org. Used in tests of :mod:`sklearn.datasets`.
236237

237238
- :func:`testing.all_estimators` : returns a list of all estimators in
238-
sklearn to test for consistent behavior and interfaces.
239+
scikit-learn to test for consistent behavior and interfaces.
239240

240241
Multiclass and multilabel utility function
241242
==========================================

0 commit comments

Comments
 (0)