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.

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

Fix typos in the extension names #582

Merged
merged 6 commits into from
Aug 28, 2023
Merged

Fix typos in the extension names #582

merged 6 commits into from
Aug 28, 2023

Conversation

ChrisRackauckas
Copy link
Member

Someone's going to have to handle the filenames manually though I think because just a caps difference isn't showing up in my Git as a change to commit.

Copy link

@ai-maintainer ai-maintainer bot left a comment

Choose a reason for hiding this comment

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

AI-Maintainer Review for PR - Fix typos in the extension names

Title and Description 👍

The Title is clear and concise
The title of the pull request is clear and concise. It effectively communicates the purpose of the changes, which is to fix the typos in the extension names.
The Description lacks testing details
The description of the pull request does not provide information about how the changes were tested. It would be beneficial for the author to include details about the testing process they followed to ensure that the changes made in the pull request are functioning as intended.

Scope of Changes 👍

The changes are narrowly focused
The changes in this pull request appear to be narrowly focused on fixing typographical errors in the extension names. The diff shows modifications to the extension names in multiple files, ensuring consistency and correctness. There is no evidence to suggest that the author is trying to resolve multiple issues simultaneously.

Docstrings 👎

Docstrings are missing for the modules
Upon reviewing the diff, I have identified the following modules that do not have docstrings:
  1. module OptimizationFiniteDiffExt
  2. module OptimizationForwardDiffExt
  3. module OptimizationReverseDiffExt
  4. module OptimizationSparseFiniteDiffExt
  5. module OptimizationSparseForwardDiffExt

These modules should have docstrings describing their behavior, arguments, and return values.

Suggested Changes

  1. Please add docstrings to the modules OptimizationFiniteDiffExt, OptimizationForwardDiffExt, OptimizationReverseDiffExt, OptimizationSparseFiniteDiffExt, and OptimizationSparseForwardDiffExt to describe their behavior, arguments, and return values.
  2. Please update the description to include details about how the changes were tested.

Reviewed with AI Maintainer

@codecov
Copy link

codecov bot commented Aug 27, 2023

Codecov Report

Merging #582 (3f5022b) into master (2233bbc) will not change coverage.
The diff coverage is 0.00%.

@@           Coverage Diff           @@
##           master     #582   +/-   ##
=======================================
  Coverage   10.19%   10.19%           
=======================================
  Files          41       41           
  Lines        2451     2451           
=======================================
  Hits          250      250           
  Misses       2201     2201           
Files Changed Coverage Δ
ext/OptimizationFiniteDiffExt.jl 0.00% <ø> (ø)
ext/OptimizationForwardDiffExt.jl 0.00% <ø> (ø)
ext/OptimizationReverseDiffExt.jl 0.00% <ø> (ø)
ext/OptimizationSparseFiniteDiffExt.jl 0.00% <ø> (ø)
ext/OptimizationSparseForwardDiffExt.jl 0.00% <ø> (ø)
src/Optimization.jl 33.33% <0.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@Vaibhavdixit02
Copy link
Member

The casing is better this way, but I don't think I understand why this would make a difference to the precompilation warning?

@ChrisRackauckas
Copy link
Member Author

I thought you had a typo somewhere causing it because these were all incorrect, so one that was correct would lead to an issue. This didn't solve the issue, but it at least rules out an issue.

@ChrisRackauckas ChrisRackauckas merged commit 5ec6da7 into master Aug 28, 2023
40 of 43 checks passed
@ChrisRackauckas ChrisRackauckas deleted the typos branch August 28, 2023 10:34
@Vaibhavdixit02
Copy link
Member

Yeah makes sense. I think the imports are the issue as you pointed out in the issue

@ChrisRackauckas
Copy link
Member Author

ChrisRackauckas commented Aug 28, 2023

In an extension you're only supposed to import the package or its extensions, not other dependencies. You can grab the dependencies via Optimization.Symbolics but are not supposed to actually import from the global space

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants