Skip to content

feat!: migrate math/base/ops/add to number/float64/base/add #5083

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 3 commits into from
Feb 8, 2025

Conversation

gururaj1512
Copy link
Member

Progresses #2261.

Description

What is the purpose of this pull request?

This pull request:

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

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

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
---
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: 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: na
  - task: lint_license_headers
    status: passed
---
This commit removes `@stdlib/math/base/ops/add` in favor of
`@stdlib/number/float64/base/add`.

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

To migrate, users should update their require/import paths to use
`@stdlib/number/float64/base/add` 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: passed
  - task: run_c_benchmarks
    status: na
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: passed
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: na
---
@gururaj1512 gururaj1512 marked this pull request as ready for review February 6, 2025 20:40
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Feb 6, 2025
@gururaj1512
Copy link
Member Author

@kgryte, PR Ready for review.

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.

LGTM. The only minor quibble which you fixed in the commit updating paths was the C symbol name stdlib_base_float64_add, which should have been changed during the first commit. Given that number/float64/base/add was a "new" package, this oversight shouldn't block this PR from being merged. Thanks for working on this, @gururaj1512. Given add's common usage, this was likely the most complicated of the migrations.

@kgryte
Copy link
Member

kgryte commented Feb 8, 2025

The lint error is unrelated to changes introduced in this PR.

@kgryte kgryte merged commit b253140 into stdlib-js:develop Feb 8, 2025
28 of 29 checks passed
@kgryte kgryte added release: Major Breaking change requiring a new major release. Math Issue or pull request specific to math functionality. and removed Needs Review A pull request which needs code review. labels Feb 8, 2025
@gururaj1512
Copy link
Member Author

LGTM. The only minor quibble which you fixed in the commit updating paths was the C symbol name stdlib_base_float64_add, which should have been changed during the first commit. Given that number/float64/base/add was a "new" package, this oversight shouldn't block this PR from being merged. Thanks for working on this, @gururaj1512. Given add's common usage, this was likely the most complicated of the migrations.

Loved working on this...!
Moving forward to resolve #2261 completely

@gururaj1512 gururaj1512 deleted the migrate-math-base-ops-add branch February 8, 2025 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Math Issue or pull request specific to math functionality. release: Major Breaking change requiring a new major release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants