Release v0.3.0

stdlib-js · Jul 28, 2024 · 1732457 · 1732457
1 parent 0ff204b
commit 1732457
Show file tree

Hide file tree

Showing 10 changed files with 143 additions and 68 deletions.
diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml
@@ -94,8 +94,8 @@ jobs:
             node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );"
           fi
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -191,8 +191,8 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -366,8 +366,8 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -539,8 +539,8 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -735,8 +735,8 @@ jobs:
             echo "bump=true" >> $GITHUB_OUTPUT
           fi
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         if: steps.check-if-bump.outputs.bump
         run: |
           git config --local user.email "noreply@stdlib.io"

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -72,8 +72,8 @@ jobs:
           node-version: 20
         timeout-minutes: 5
 
-      # Configure git:
-      - name: 'Configure git'
+      # Configure Git:
+      - name: 'Configure Git'
         run: |
           git config --local user.email "noreply@stdlib.io"
           git config --local user.name "stdlib-bot"
@@ -206,7 +206,7 @@ jobs:
       # Publish package to npm:
       - name: 'Publish package to npm'
         # Pin action to full length commit SHA
-        uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1
+        uses: JS-DevTools/npm-publish@19c28f1ef146469e409470805ea4279d47c3d35c # v3.1.1
         with:
           token: ${{ secrets.NPM_TOKEN }}
           access: public

diff --git a/.npmrc b/.npmrc
@@ -27,5 +27,5 @@ shrinkwrap = false
 # Disable automatically "saving" dependencies on install:
 save = false
 
-# Generate provenance metadata:
-provenance = true
+# Do not generate provenance metadata:
+provenance = false
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,15 +2,15 @@
 
 > Package changelog.
 
-<section class="release" id="unreleased">
+<section class="release" id="v0.3.0">
 
-## Unreleased (2024-07-14)
+## 0.3.0 (2024-07-28)
 
 <section class="features">
 
 ### Features
 
--   [`337adbf`](https://github.com/stdlib-js/stdlib/commit/337adbf93822a5ab1adb5256594855e344e9414c) - add C implementation for `math/base/special/digamma` [(##2533)](#2533 )
+-   [`337adbf`](https://github.com/stdlib-js/stdlib/commit/337adbf93822a5ab1adb5256594855e344e9414c) - add C implementation for `math/base/special/digamma` [(#2533)](https://github.com/stdlib-js/stdlib/pull/2533 )
 
 </section>
 
@@ -22,10 +22,13 @@
 
 <details>
 
+-   [`272ae7a`](https://github.com/stdlib-js/stdlib/commit/272ae7ac5c576c68cfab1b6e304c86407faa20cd) - **docs:** remove comment _(by Athan Reines)_
+-   [`55ec8ed`](https://github.com/stdlib-js/stdlib/commit/55ec8edfeb7000bca7478af116e794f20560e922) - **docs:** remove comment _(by Athan Reines)_
+-   [`2777e4b`](https://github.com/stdlib-js/stdlib/commit/2777e4be161869d09406e3b17947d24c64b47af2) - **bench:** resolve lint errors in benchmarks _(by Athan Reines)_
 -   [`26337e1`](https://github.com/stdlib-js/stdlib/commit/26337e1644c963b8006e38c4b5e2ee74eac8e33f) - **docs:** fix return annotation tag in C comments _(by Philipp Burckhardt)_
 -   [`e9d0de8`](https://github.com/stdlib-js/stdlib/commit/e9d0de8077f47e49ff703c1b106e262454e5d15d) - **chore:** update package meta data [(#2596)](https://github.com/stdlib-js/stdlib/pull/2596) _(by stdlib-bot, Athan Reines)_
--   [`ed638e3`](https://github.com/stdlib-js/stdlib/commit/ed638e392f7425c899abda488b943d0ffbd37f78) - **docs:** update Boost version and fix C function name in README.md [(##2577)](#2577) _(by Gunj Joshi)_
--   [`337adbf`](https://github.com/stdlib-js/stdlib/commit/337adbf93822a5ab1adb5256594855e344e9414c) - **feat:** add C implementation for `math/base/special/digamma` [(##2533)](#2533 ) _(by Gunj Joshi)_
+-   [`ed638e3`](https://github.com/stdlib-js/stdlib/commit/ed638e392f7425c899abda488b943d0ffbd37f78) - **docs:** update Boost version and fix C function name in README.md [(#2577)](https://github.com/stdlib-js/stdlib/pull/2577) _(by Gunj Joshi)_
+-   [`337adbf`](https://github.com/stdlib-js/stdlib/commit/337adbf93822a5ab1adb5256594855e344e9414c) - **feat:** add C implementation for `math/base/special/digamma` [(#2533)](https://github.com/stdlib-js/stdlib/pull/2533 ) _(by Gunj Joshi)_
 
 </details>
 
@@ -55,6 +58,26 @@ A total of 3 people contributed to this release. Thank you to the following cont
 
 ## 0.2.1 (2024-02-24)
 
+No changes reported for this release.
+
+</section>
+
+<!-- /.release -->
+
+<section class="release" id="v0.2.0">
+
+## 0.2.0 (2024-02-14)
+
+No changes reported for this release.
+
+</section>
+
+<!-- /.release -->
+
+<section class="release" id="v0.1.0">
+
+## 0.1.0 (2023-09-24)
+
 <section class="features">
 
 ### Features
@@ -111,3 +134,63 @@ A total of 1 person contributed to this release. Thank you to this contributor:
 
 <!-- /.release -->
 
+<section class="release" id="v0.0.6">
+
+## 0.0.6 (2022-02-16)
+
+No changes reported for this release.
+
+</section>
+
+<!-- /.release -->
+
+<section class="release" id="v0.0.5">
+
+## 0.0.5 (2021-08-23)
+
+No changes reported for this release.
+
+</section>
+
+<!-- /.release -->
+
+<section class="release" id="v0.0.4">
+
+## 0.0.4 (2021-07-07)
+
+No changes reported for this release.
+
+</section>
+
+<!-- /.release -->
+
+<section class="release" id="v0.0.3">
+
+## 0.0.3 (2021-06-27)
+
+No changes reported for this release.
+
+</section>
+
+<!-- /.release -->
+
+<section class="release" id="v0.0.2">
+
+## 0.0.2 (2021-06-16)
+
+No changes reported for this release.
+
+</section>
+
+<!-- /.release -->
+
+<section class="release" id="v0.0.1">
+
+## 0.0.1 (2021-06-15)
+
+No changes reported for this release.
+
+</section>
+
+<!-- /.release -->
+
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -51,6 +51,7 @@ Muhammad Haris <harriskhan047@outlook.com>
 Naresh Jagadeesan <naresh.naresh000@gmail.com>
 NightKnight <Ahmedatwa866@yahoo.com>
 Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
+Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com>
 Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
 Oneday12323 <107678750+Oneday12323@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>

diff --git a/README.md b/README.md
@@ -286,8 +286,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-digamma.svg
 [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-digamma
 
-[test-image]: https://github.com/stdlib-js/math-base-special-digamma/actions/workflows/test.yml/badge.svg?branch=main
-[test-url]: https://github.com/stdlib-js/math-base-special-digamma/actions/workflows/test.yml?query=branch:main
+[test-image]: https://github.com/stdlib-js/math-base-special-digamma/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/math-base-special-digamma/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-digamma/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-digamma?branch=main

diff --git a/benchmark/c/cephes/benchmark.c b/benchmark/c/cephes/benchmark.c
@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 
-/**
-* Benchmark Cephes `psi`.
-*/
 #include <stdlib.h>
 #include <stdio.h>
 #include <math.h>
@@ -37,7 +34,7 @@ extern double psi( double x );
 /**
 * Prints the TAP version.
 */
-void print_version() {
+static void print_version( void ) {
 	printf( "TAP version 13\n" );
 }
 
@@ -47,7 +44,7 @@ void print_version() {
 * @param total     total number of tests
 * @param passing   total number of passing tests
 */
-void print_summary( int total, int passing ) {
+static void print_summary( int total, int passing ) {
 	printf( "#\n" );
 	printf( "1..%d\n", total ); // TAP plan
 	printf( "# total %d\n", total );
@@ -61,7 +58,7 @@ void print_summary( int total, int passing ) {
 *
 * @param elapsed   elapsed time in seconds
 */
-void print_results( double elapsed ) {
+static void print_results( double elapsed ) {
 	double rate = (double)ITERATIONS / elapsed;
 	printf( "  ---\n" );
 	printf( "  iterations: %d\n", ITERATIONS );
@@ -75,18 +72,18 @@ void print_results( double elapsed ) {
 *
 * @return clock time
 */
-double tic() {
+static double tic( void ) {
 	struct timeval now;
 	gettimeofday( &now, NULL );
 	return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
 }
 
 /**
-* Generates a random number on the interval [0,1].
+* Generates a random number on the interval [0,1).
 *
 * @return random number
 */
-double rand_double() {
+static double rand_double( void ) {
 	int r = rand();
 	return (double)r / ( (double)RAND_MAX + 1.0 );
 }
@@ -96,7 +93,7 @@ double rand_double() {
 *
 * @return elapsed time in seconds
 */
-double benchmark() {
+static double benchmark( void ) {
 	double elapsed;
 	double x;
 	double y;

diff --git a/benchmark/c/native/benchmark.c b/benchmark/c/native/benchmark.c
@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 
-/**
-* Benchmark `digamma`.
-*/
 #include "stdlib/math/base/special/digamma.h"
 #include <stdlib.h>
 #include <stdio.h>
@@ -33,7 +30,7 @@
 /**
 * Prints the TAP version.
 */
-void print_version() {
+static void print_version( void ) {
 	printf( "TAP version 13\n" );
 }
 
@@ -43,7 +40,7 @@ void print_version() {
 * @param total     total number of tests
 * @param passing   total number of passing tests
 */
-void print_summary( int total, int passing ) {
+static void print_summary( int total, int passing ) {
 	printf( "#\n" );
 	printf( "1..%d\n", total ); // TAP plan
 	printf( "# total %d\n", total );
@@ -57,7 +54,7 @@ void print_summary( int total, int passing ) {
 *
 * @param elapsed   elapsed time in seconds
 */
-void print_results( double elapsed ) {
+static void print_results( double elapsed ) {
 	double rate = (double)ITERATIONS / elapsed;
 	printf( "  ---\n" );
 	printf( "  iterations: %d\n", ITERATIONS );
@@ -71,18 +68,18 @@ void print_results( double elapsed ) {
 *
 * @return clock time
 */
-double tic() {
+static double tic( void ) {
 	struct timeval now;
 	gettimeofday( &now, NULL );
 	return (double)now.tv_sec + (double)now.tv_usec / 1.0e6;
 }
 
 /**
-* Generates a random number on the interval [0,1].
+* Generates a random number on the interval [0,1).
 *
 * @return random number
 */
-double rand_double() {
+static double rand_double( void ) {
 	int r = rand();
 	return (double)r / ( (double)RAND_MAX + 1.0 );
 }
@@ -92,7 +89,7 @@ double rand_double() {
 *
 * @return elapsed time in seconds
 */
-double benchmark() {
+static double benchmark( void ) {
 	double elapsed;
 	double x;
 	double y;

diff --git a/include/stdlib/math/base/special/digamma.h b/include/stdlib/math/base/special/digamma.h
@@ -16,9 +16,6 @@
 * limitations under the License.
 */
 
-/**
-* Header file containing function declarations.
-*/
 #ifndef STDLIB_MATH_BASE_SPECIAL_DIGAMMA_H
 #define STDLIB_MATH_BASE_SPECIAL_DIGAMMA_H