Skip to content

docs: capitalize Pearson and close backtick in stats/strided/dpcorrwd#11515

Merged
kgryte merged 1 commit intodevelopfrom
philipp/fix-dpcorrwd-docs-typos
Apr 17, 2026
Merged

docs: capitalize Pearson and close backtick in stats/strided/dpcorrwd#11515
kgryte merged 1 commit intodevelopfrom
philipp/fix-dpcorrwd-docs-typos

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

@Planeshifter Planeshifter commented Apr 17, 2026

Description

What is the purpose of this pull request?

This pull request:

  • Capitalizes the proper noun "Pearson" in the @stdlib/stats/strided/dpcorrwd package.json description so that it matches the capitalization already used throughout the README (e.g., "sample Pearson product-moment correlation coefficient").
  • Closes an unterminated backtick in the JSDoc @param strideX description in docs/types/index.d.ts. Previously the line read * @param strideX - stride length of \x` (no closing backtick), which would cause IDE/TSDoc renderers to treat the remainder of the comment block as inline code.

Both issues were surfaced during a review of the packages touched by the last commits on develop. A codebase-wide scan (JSDoc/comment lines and markdown outside fenced code blocks) found no other instances of unbalanced backticks.

Related Issues

Does this pull request have any related issues?

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

Diff is two characters across two files — pure docs fix, no behavior change.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of 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

Both typos were identified and fixed by Claude Code during a review of recent develop commits, and Claude Code also ran the codebase-wide backtick-balance scan that confirmed no other instances. I reviewed and approved the diff manually before committing.


@stdlib-js/reviewers

…rwd`

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label Apr 17, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/strided/dpcorrwd $\color{red}511/513$
$\color{green}+99.61%$
$\color{red}18/19$
$\color{green}+94.74%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{red}511/513$
$\color{green}+99.61%$

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

@Planeshifter Planeshifter marked this pull request as ready for review April 17, 2026 20:55
@Planeshifter Planeshifter requested review from a team and kgryte April 17, 2026 20:55
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 17, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Apr 17, 2026
@kgryte kgryte merged commit e616ec3 into develop Apr 17, 2026
58 checks passed
@kgryte kgryte deleted the philipp/fix-dpcorrwd-docs-typos branch April 17, 2026 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants