Repository navigation
Improved distances docs - #41
Merged
Merged
Conversation
Closes #5. Rewrites all 43 function docstrings and the module docstring for consistent formatting; no code changes (AST-identical with docstrings excluded). - Parameters: proper `u, v : array_like` entries instead of "- u, v:" bullets; document the previously undocumented `w` (SciPy wrappers), `centered` (correlation) and `p` (minkowski). - Returns: typed (`float`) with description. - Sections in numpydoc order (Parameters, Returns, See Also, Notes, References); Notes/References no longer over-indented, which rendered as blockquotes. - "Synonyms:" blocks become an "Also known as" line in the summary. - SciPy wrappers get a See Also entry for the underlying function (replaces cosine's bare "SciPy." reference). - References as plain numbered lists with one canonical Cha (2007) citation (previously 6 spellings). Not `.. [n]` citations: with napoleon all functions share one page, so labels would collide. - correlation: document the RuntimeWarning / return 0 behaviour. - jensenshannon_divergence: stray "Comments:" code moved into Notes as a literal block. - Module docstring: fix the RST errors (indented Notes, "Copyright" parsed as a section title), the "Minimimum" typo, and replace the `# noqa` long URL with a wrapped link target (same full permalink). - Wording: "Added by SC." spelled out, "Equals to ..." and other tautologies/grammar fixed. numpydoc validation: 314 errors -> 0. Sphinx (autodoc + napoleon, as in docs/conf.py) on the distances page: 3 errors/warnings -> 0.
This module's dice (sum((u-v)^2) / (sum(u^2) + sum(v^2))) and sorensen (sum|u-v| / sum(u+v)) compute different formulas; the names only coincide for the set-based Sorensen-Dice coefficient.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.