Skip to content

docs: add introductory text to READMEs - #14697

Merged
kgryte merged 1 commit into
stdlib-js:developfrom
anandkaranubc:docs/add-equations-kernel
Aug 27, 2026
Merged

docs: add introductory text to READMEs#14697
kgryte merged 1 commit into
stdlib-js:developfrom
anandkaranubc:docs/add-equations-kernel

Conversation

@anandkaranubc

@anandkaranubc anandkaranubc commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Progresses stdlib-js/metr-issue-tracker#1257

Description

What is the purpose of this pull request?

This pull request:

  • add introductory text to kernel function READMEs

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

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.

No.

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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

Used Claude Code code-generation tools to help assist with the feature.

@stdlib-js/reviewers

@anandkaranubc
docs: add introductory text to kernel function READMEs
a45b98a 
Add descriptive introductory text to the intro sections of kernel-cos,
kernel-sin, kernel-tan, kernel-sincos, kernel-log1p, kernel-betainc,
kernel-betaincinv and their single-precision variants. Kernel functions
receive prose descriptions noting their valid input range rather than
standalone equations.

Ref: stdlib-js/metr-issue-tracker#1257
@anandkaranubc
anandkaranubc requested a review from a team August 27, 2026 06:00
@anandkaranubc anandkaranubc added Needs Review A pull request which needs code review. Documentation Improvements, additions, or changes to documentation. Math Issue or pull request specific to math functionality. METR Pull request associated with the METR project. labels Aug 27, 2026
@stdlib-bot

stdlib-bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Coverage Report

No coverage information available.

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Aug 27, 2026
@kgryte
kgryte merged commit d5da0cb into stdlib-js:develop Aug 27, 2026
81 checks passed
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte approved these changes

Assignees

No one assigned

Labels

Documentation Improvements, additions, or changes to documentation. Math Issue or pull request specific to math functionality. METR Pull request associated with the METR project.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@anandkaranubc @stdlib-bot @kgryte