Description
I think common things in documentation should be written in a consistent way. Right now I can think of the following points:
-
Whether to name entities which can be transformed to
ndarray
asarray
orarray-like
. -
How to list different input options. Should curly braces always be used? For example:
X : {array-like, sparse matrix}
-
Optional arguments / default values. Some convention should be adopted, like:
kernel : string, default ’rbf’
or
kernel : string (default='rbf')
The word
optional
should be dropped anyway as redundant. -
How to name
X
andy
arrays infit
andpredict
methods. The one adopted convention would be helpful. -
How to mention shapes of arrays. I was told that
X, shape (n_samples, n_features)
was adopted, is it true? How about 1-d arrays:(n_samples)
or(n_samples,)
?
Anyway, do you think it is an issue at all? Maybe core developers could decide and update coding guidelines? I listed only some points.