Skip to content

docs: lowercase 'binomial' in description #7763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 29, 2025

Conversation

AbhishekG-Codes
Copy link
Contributor

Resolves

Resolves #7758

Description

What is the purpose of this pull request?

This pull request addresses a reviewer comment from commit 394df9c by:

  • Fixing a capitalization issue in the README file for the binomial distribution's entropy documentation.
  • Specifically, changing "Binomial" to "binomial" to follow the standard lowercase naming convention used throughout the project.

Related Issues

Does this pull request have any 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 additional notes.

Checklist

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


@stdlib-js/reviewers

@stdlib-bot stdlib-bot added the Good First PR A pull request resolving a Good First Issue. label Jul 28, 2025
@stdlib-bot
Copy link
Contributor

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

Getting Started

Next Steps

  1. A project maintainer will approve GitHub Actions workflows for your PR.
  2. All CI checks must pass before your submission can be fully reviewed.
  3. You'll need to address any failures in linting or unit tests.

Running Tests Locally

You can use make to run any of the CI commands locally from the root directory of the stdlib repository:

# Run tests for all packages in the math namespace:
make test TESTS_FILTER=".*/@stdlib/math/.*"

# Run benchmarks for a specific package:
make benchmark BENCHMARKS_FILTER=".*/@stdlib/math/base/special/sin/.*"

If you haven't heard back from us within two weeks, please ping us by tagging the "reviewers" team in a comment on this PR.

If you have any further questions while waiting for a response, please join our Gitter channel to chat with project maintainers and other community members.

We appreciate your contribution!

Documentation Links

@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Needs Review A pull request which needs code review. labels Jul 28, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Jul 28, 2025

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/binomial/entropy $\color{green}203/203$
$\color{green}+100.00\%$
$\color{green}22/22$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}203/203$
$\color{green}+100.00\%$

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

Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AbhishekG-Codes Please pay closer attention to what the upstream issue requested. It gave you all the requisite line information. I went ahead and made the actual requested change.

@kgryte kgryte merged commit b6ca4b7 into stdlib-js:develop Jul 29, 2025
9 checks passed
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Jul 29, 2025
@kgryte kgryte changed the title fix(docs): lowercase 'binomial' in entropy package heading docs: lowercase 'binomial' in description Jul 29, 2025
@AbhishekG-Codes
Copy link
Contributor Author

@AbhishekG-Codes Please pay closer attention to what the upstream issue requested. It gave you all the requisite line information. I went ahead and made the actual requested change.

Hi @kgryte , thank you for pointing that out.

You're right, I missed the specific line instructions in the upstream issue. I appreciate you taking the time to make the correct change. I’ll be more careful in the future and double-check the context before raising a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. Statistics Issue or pull request related to statistical functionality.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Address commit comments (commit 394df9c)
3 participants