Skip to content

docs: add link#13406

Merged
kgryte merged 2 commits into
developfrom
philipp/drift-stats-base-dists-cauchy-2026-07-10
Jul 10, 2026
Merged

docs: add link#13406
kgryte merged 2 commits into
developfrom
philipp/drift-stats-base-dists-cauchy-2026-07-10

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

Link the term probability density function to the [pdf] reference in the opening blockquote of both stats/base/dists/cauchy/pdf/README.md and stats/base/dists/cauchy/logpdf/README.md. Every other non-ctor sibling in the cauchy namespace already wraps its mathematical term in a reference-style link on that line ([cumulative distribution function][cdf], [differential entropy][entropy], [median][median], [mode][mode], [quantile function][quantile-function]). The [pdf]: reference is already defined at the bottom of both files, so the link resolves without further changes. Conformance on this line goes from 6/8 to 8/8; the "natural logarithm of" phrasing in logpdf (from 8d60f41, propagated via #12736) is preserved.

@stdlib/stats/base/dists/cauchy/pdf

Fixed the drift in pdf's README: line 23's opening blockquote referenced "probability density function" as plain text instead of the [probability density function][pdf] link every other non-ctor sibling uses there, even though the [pdf]: reference definition already existed at the bottom of the file. One-line change, brings the cauchy namespace from 6/8 to 8/8 conformance on this pattern. No behavioral, test, or signature changes.

@stdlib/stats/base/dists/cauchy/logpdf

Fixed the logpdf README to link probability density function to the [pdf] reference, matching the pattern used by 6 of the other 7 non-ctor siblings in @stdlib/stats/base/dists/cauchy. The [pdf] anchor was already defined at the bottom of the file, so this is a pure markup fix — no behavioral, test, or signature changes. Namespace conformance on this line goes from 6/8 to 8/8.

Related Issues

None.

Questions

None.

Other

Single conformance percentage: 6/8 non-ctor sibling packages already reference-link the mathematical term in the opening blockquote (75%); pdf and logpdf were the two outliers.

Checklist

AI Assistance

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

This PR was authored by Claude Code as part of an automated cross-package drift-detection sweep. The routine extracted structural and semantic features from every package in stats/base/dists/cauchy/, computed a per-feature majority pattern, and validated each candidate correction through a structural-review agent (confirmed the linked form is the file's own established convention and the un-linked blockquote is the outlier) and a cross-reference agent (confirmed no test, example, docs/types/*, or generated file depends on the current wording) before any edit. The single correction is a pure Markdown link addition; no behavior, signatures, or tests changed.


@stdlib-js/reviewers


Generated by Claude Code

claude added 2 commits July 10, 2026 08:23
…/pdf` README

Reference-link the term `probability density function` in the README
opening description quote, matching the sibling `cauchy` namespace
convention. Six of eight non-`ctor` packages (`cdf`, `entropy`, `logcdf`,
`median`, `mode`, `quantile`) already wrap the term in a reference-style
link on that line; `pdf` was the outlier. The `[pdf]` reference is
already defined at the bottom of the file, so the link resolves without
further changes.

Ref: #11942
…/logpdf` README

Reference-link the term `probability density function` in the README
opening description quote, matching the sibling `cauchy` namespace
convention. Six of eight non-`ctor` packages already wrap the term in a
reference-style link on that line; `logpdf` was one of two outliers. The
`[pdf]` reference is already defined at the bottom of the file, so the
link resolves without further changes. The "natural logarithm of" phrase
introduced in 8d60f41 is preserved.

Ref: #11942
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Jul 10, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/cauchy/logpdf $\\color{green}293/293$
$\\color{green}+100.00\\%$
$\\color{green}19/19$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}293/293$
$\\color{green}+100.00\\%$
stats/base/dists/cauchy/pdf $\\color{green}293/293$
$\\color{green}+100.00\\%$
$\\color{green}19/19$
$\\color{green}+100.00\\%$
$\\color{green}4/4$
$\\color{green}+100.00\\%$
$\\color{green}293/293$
$\\color{green}+100.00\\%$

The above coverage report was generated for the changes in this PR.

@kgryte kgryte marked this pull request as ready for review July 10, 2026 08:34
@kgryte kgryte requested a review from a team July 10, 2026 08:34
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jul 10, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Jul 10, 2026
@kgryte kgryte changed the title docs: link probability density function in stats/base/dists/cauchy/{pdf,logpdf} READMEs docs: add link Jul 10, 2026
@kgryte kgryte merged commit 2180fed into develop Jul 10, 2026
70 checks passed
@kgryte kgryte deleted the philipp/drift-stats-base-dists-cauchy-2026-07-10 branch July 10, 2026 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants