-
-
Notifications
You must be signed in to change notification settings - Fork 911
Description
This commit has 3 comment(s) from core contributors that require attention.
Commit: 2616db935d792a899cd88d208e06460edfe53723
Comments:
-
Line 132: @stdlib-bot Lines L132-135 should be moved to L224.
stdlib/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/README.md
Lines 129 to 135 in 2616db9
<!-- /.examples --> <!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> <section class="references"> -
Line 222: @stdlib-bot Missing a closing
</section>
and trailing comment to pair with the<section class="c">
above. See other package READMEs for an example of what we are looking for.stdlib/lib/node_modules/@stdlib/stats/base/dists/geometric/cdf/README.md
Lines 219 to 225 in 2616db9
printf( "x: %lf, p: %lf, F(x;p): %lf\n", x, p, y ); } } ``` </section> -
Line 30: @stdlib-bot This should be
@return
. Make sure to re-align the descriptions. Doxygen comments don't follow JSDoc conventions.* * @param x input value * @param p success probability * @returns evaluated CDF * * @example * double y = stdlib_base_dists_geometric_cdf( 2.0, 0.5 );
Interested in helping improve the project? If you are, the comment linked to above has 3 comment(s) from core contributors that could use your attention.
What do you need to do?
- Open the above linked comments mentioning @stdlib-bot.
- Review the suggested changes or follow-up tasks (e.g., formatting improvements, small refactorings, or clean-up).
- If you are a first-time contributor, follow the contributing and development guides to setup your local environment for contributing to stdlib. If you are already a seasoned stdlib contributor, create a new branch on your local fork for making the changes.
- Make all the desired changes and commit those changes to a local branch.
- Push the changes to GitHub and open a new pull request against the
develop
branch of the main stdlib development repository.
Once you've opened a pull request, a stdlib maintainer will review your work and suggest any follow-up changes.
And that's it!
Thank you for your help in reducing the project backlog and in improving the quality of stdlib. 🙌
Notes
- For older commits, there is a chance that comments will have been already been addressed due to other refactorings. If you find that to be true, don't worry! Just move on to addressing the next comment, and, when opening your pull request and describing your proposed changes, be sure to link to the comment and mention that it has been addressed. This will help reviewers when reviewing your code!
This issue was created automatically to address commit comments tagging @stdlib-bot.