Document `cdist`'s/`pdist`'s keyword arguments V, VI, and w #69

jakirkham · 2017-10-06T20:05:42Z

Missed documenting the keyword arguments V, VI, and w of cdist and pdist when adding the metrics seuclidean, mahalanobis, and wminkowski respectively in PR ( #66 ). This corrects that oversight by adding brief explanations of them to the docstring.

Missed documenting `V` when adding support for the `seuclidean` metric in `cdist`. So this adds documentation for that parameter along with a brief explanation of how the default value is determined.

Missed documenting `V` when adding support for the `seuclidean` metric in `pdist`. So this adds documentation for that parameter along with a brief explanation of how the default value is determined.

Missed documenting `VI` when adding support for the `mahalanobis` metric in `cdist`. So this adds documentation for that parameter along with a brief explanation of how the default value is determined.

Missed documenting `VI` when adding support for the `mahalanobis` metric in `pdist`. So this adds documentation for that parameter along with a brief explanation of how the default value is determined.

Missed documenting `w` when adding support for the `wminkowski` metric in `cdist`. So this adds documentation for that parameter and notes that it is mandatory (no default).

Missed documenting `w` when adding support for the `wminkowski` metric in `pdist`. So this adds documentation for that parameter and notes that it is mandatory (no default).

jakirkham added 4 commits October 6, 2017 16:11

Doc cdist's keyword argument V

054bfed

Missed documenting `V` when adding support for the `seuclidean` metric in `cdist`. So this adds documentation for that parameter along with a brief explanation of how the default value is determined.

Doc pdist's keyword argument V

f3a62ed

Missed documenting `V` when adding support for the `seuclidean` metric in `pdist`. So this adds documentation for that parameter along with a brief explanation of how the default value is determined.

Doc cdist's keyword argument VI

0ff6d32

Missed documenting `VI` when adding support for the `mahalanobis` metric in `cdist`. So this adds documentation for that parameter along with a brief explanation of how the default value is determined.

Doc pdist's keyword argument VI

4b9a1d7

Missed documenting `VI` when adding support for the `mahalanobis` metric in `pdist`. So this adds documentation for that parameter along with a brief explanation of how the default value is determined.

jakirkham force-pushed the dists_doc_more_kwargs branch from 6af03bf to 01128a3 Compare October 6, 2017 20:21

jakirkham added 2 commits October 6, 2017 16:22

Doc cdist's keyword argument w

e9b89ae

Missed documenting `w` when adding support for the `wminkowski` metric in `cdist`. So this adds documentation for that parameter and notes that it is mandatory (no default).

Doc pdist's keyword argument w

f487978

Missed documenting `w` when adding support for the `wminkowski` metric in `pdist`. So this adds documentation for that parameter and notes that it is mandatory (no default).

jakirkham force-pushed the dists_doc_more_kwargs branch from 01128a3 to f487978 Compare October 6, 2017 20:23

jakirkham changed the title ~~Document cdist's and pdist's keyword arguments V and VI~~ Document cdist's and pdist's keyword arguments V, VI, and w Oct 6, 2017

jakirkham changed the title ~~Document cdist's and pdist's keyword arguments V, VI, and w~~ Document cdist's/pdist's keyword arguments V, VI, and w Oct 6, 2017

jakirkham merged commit e8d3559 into master Oct 6, 2017

jakirkham deleted the dists_doc_more_kwargs branch October 6, 2017 20:32

jakirkham changed the title ~~Document cdist's/pdist's keyword arguments V, VI, and w~~ Document cdist's/pdist's keyword arguments V, VI, and w Oct 9, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document `cdist`'s/`pdist`'s keyword arguments V, VI, and w #69

Document `cdist`'s/`pdist`'s keyword arguments V, VI, and w #69

jakirkham commented Oct 6, 2017 •

edited

Document cdist's/pdist's keyword arguments V, VI, and w #69

Document cdist's/pdist's keyword arguments V, VI, and w #69

Conversation

jakirkham commented Oct 6, 2017 • edited

Document `cdist`'s/`pdist`'s keyword arguments V, VI, and w #69

Document `cdist`'s/`pdist`'s keyword arguments V, VI, and w #69

jakirkham commented Oct 6, 2017 •

edited