Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat!: migrate math/base/ops/add5 to number/float64/base/add5 #5174

Merged
merged 4 commits into from
Feb 16, 2025
Merged

feat!: migrate math/base/ops/add5 to number/float64/base/add5 #5174

merged 4 commits into from
Feb 16, 2025

Conversation

gururaj1512
Copy link
Contributor

Progresses #2261.

Description

What is the purpose of this pull request?

This pull request:

  • feat: migrate math/base/ops/add5 to number/float64/base/add5

Related Issues

Does this pull request have any related issues?

This pull request:

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.

@stdlib-js/reviewers

@gururaj1512
feat: add number/float64/base/add5
9482391 
Ref: stdlib-js#2261

---
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: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: missing_dependencies
  - task: lint_c_examples
    status: missing_dependencies
  - task: lint_c_benchmarks
    status: missing_dependencies
  - 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
---
@gururaj1512
refactor: update paths
3ae3c5f 
Ref: stdlib-js#2261

---
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: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - 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: na
  - task: lint_license_headers
    status: passed
---
@gururaj1512
remove: remove math/base/ops/add5
cfa99a4 
This commit removes `@stdlib/math/base/ops/add5` in favor of
`@stdlib/number/float64/base/add5`.

BREAKING CHANGE: remove `math/base/ops/add5`

To migrate, users should update their require/import paths to use
`@stdlib/number/float64/base/add5` which provides the same API and
implementation.

Ref: stdlib-js#2261

---
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: na
  - 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: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: na
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: na
  - task: run_c_benchmarks
    status: na
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: na
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: na
---
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Feb 10, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Feb 10, 2025 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
array/base $\color{green}1842/1842$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}1842/1842$
$\color{green}+100.00\%$
array/base/quinary2d $\color{green}153/153$
$\color{green}+100.00\%$ 		$\color{green}8/8$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}153/153$
$\color{green}+100.00\%$
array/base/quinary3d $\color{green}170/170$
$\color{green}+100.00\%$ 		$\color{green}9/9$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}170/170$
$\color{green}+100.00\%$
array/base/quinary4d $\color{green}187/187$
$\color{green}+100.00\%$ 		$\color{green}10/10$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}187/187$
$\color{green}+100.00\%$
array/base/quinary5d $\color{green}204/204$
$\color{green}+100.00\%$ 		$\color{green}11/11$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}204/204$
$\color{green}+100.00\%$
math/base/ops $\color{green}222/222$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}222/222$
$\color{green}+100.00\%$
namespace/alias2pkg $\color{green}95/95$
$\color{green}+100.00\%$ 		$\color{green}7/7$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}95/95$
$\color{green}+100.00\%$
namespace $\color{green}95/95$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}95/95$
$\color{green}+100.00\%$
namespace/pkg2alias $\color{green}100/100$
$\color{green}+100.00\%$ 		$\color{green}10/10$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}100/100$
$\color{green}+100.00\%$
namespace/pkg2related $\color{green}100/100$
$\color{green}+100.00\%$ 		$\color{green}10/10$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}100/100$
$\color{green}+100.00\%$
namespace/pkg2standalone $\color{green}95/95$
$\color{green}+100.00\%$ 		$\color{green}7/7$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}95/95$
$\color{green}+100.00\%$
namespace/standalone2pkg $\color{green}95/95$
$\color{green}+100.00\%$ 		$\color{green}7/7$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}95/95$
$\color{green}+100.00\%$
number/float64/base/add5 $\color{green}178/178$
$\color{green}+100.00\%$ 		$\color{green}5/5$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}178/178$
$\color{green}+100.00\%$
strided/base $\color{green}460/460$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}460/460$
$\color{green}+100.00\%$
strided/base/quinary $\color{green}269/269$
$\color{green}+100.00\%$ 		$\color{green}8/8$
$\color{green}+100.00\%$ 		$\color{green}2/2$
$\color{green}+100.00\%$ 		$\color{green}269/269$
$\color{green}+100.00\%$

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

@kgryte kgryte added release: Major Breaking change requiring a new major release. Math Issue or pull request specific to math functionality. labels Feb 16, 2025
kgryte
kgryte reviewed Feb 16, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/ops/lib/index.js
* @type {Function}
* @see {@link module:@stdlib/math/base/ops/add5}
*/
setReadOnly( ns, 'add5', require( '@stdlib/math/base/ops/add5' ) );
Copy link
Member

Choose a reason for hiding this comment

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

@gururaj1512 This is fine for this PR; however, this change needs to happen during the package removal step. This is actually a breaking change, so should not be included in this commit.

Copy link
Member

Choose a reason for hiding this comment

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

For reference, see our Git commit guide: https://github.com/stdlib-js/stdlib/tree/develop/docs/style-guides/git

Copy link
Member

Choose a reason for hiding this comment

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

@gururaj1512 Actually, sorry. Disregard my comment above. Instead of removing, just update the path. We'll clean up the namespace once everything is moved.

@kgryte kgryte removed the Needs Review A pull request which needs code review. label Feb 16, 2025
@kgryte kgryte merged commit 52b4dad into stdlib-js:develop Feb 16, 2025
13 checks passed
@gururaj1512 gururaj1512 deleted the migrate-math-base-ops-add5 branch February 16, 2025 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kgryte kgryte kgryte left review comments

Assignees
No one assigned
Labels
Math Issue or pull request specific to math functionality. release: Major Breaking change requiring a new major release.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gururaj1512 @stdlib-bot @kgryte