Closed amontoison closed 1 year ago
Thanks @amontoison! I just have a couple of questions/comments:
* why are the unit tests failing on 1.6?
I just need to check that Julia >= 1.7 in the __init__
function because LinearAlgebra.BLAS.lbt_get_config()
was only added in Julia 1.7.
* why remove the content of the readme, and what is your strategy for the documentation? I understand it is not simple to have an example for each function, but they should at least be listed in the references.
Let's update the README.md when JuliaHSL will be released. It will be tomorrow or Tuesday.
My strategy for the documentation is to provide links to the documentation of HSL packages if the users want to use the low-level wrappers.
The wrappers are just forwarding the calls to C and Fortran functions that are already documented.
The high-level Julia functions like those developed for hsl_ma57
and hsl_ma97
must have a docstring because they take different arguments.
* I am still not sure to understand why get rid of the formatter? It's really useful to have guidelines for next contributors.
I use a specific formatter when I generate the wrappers, I propose to keep it if we find a way to exclude the src/C
and src/Fortran
.
I opened the PRs #175, #176 and #177 to replace this one.
It contains the same modifications except that I didn't removed the .juliaformatter
file and the README
was not updated.
Thanks @amontoison for splitting the PR it is much clearer now
Codecov Report
Patch coverage:
0.06
% and project coverage change:-74.89
:warning:Additional details and impacted files
```diff @@ Coverage Diff @@ ## main #174 +/- ## ========================================== - Coverage 75.05% 0.16% -74.89% ========================================== Files 7 119 +112 Lines 449 4767 +4318 ========================================== - Hits 337 8 -329 - Misses 112 4759 +4647 ``` | [Impacted Files](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers) | Coverage Δ | | |---|---|---| | [src/C/hsl\_ma48.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21hNDguamw=) | `0.00% <0.00%> (ø)` | | | [src/C/hsl\_ma57.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21hNTcuamw=) | `0.00% <0.00%> (ø)` | | | [src/C/hsl\_ma77.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21hNzcuamw=) | `0.00% <0.00%> (ø)` | | | [src/C/hsl\_ma86.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21hODYuamw=) | `0.00% <0.00%> (ø)` | | | [src/C/hsl\_ma87.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21hODcuamw=) | `0.00% <0.00%> (ø)` | | | [src/C/hsl\_ma97.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21hOTcuamw=) | `0.00% <0.00%> (ø)` | | | [src/C/hsl\_mc64.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21jNjQuamw=) | `0.00% <0.00%> (ø)` | | | [src/C/hsl\_mc68.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21jNjguamw=) | `0.00% <0.00%> (ø)` | | | [src/C/hsl\_mc69.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21jNjkuamw=) | `0.00% <0.00%> (ø)` | | | [src/C/hsl\_mc78.jl](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers#diff-c3JjL0MvaHNsX21jNzguamw=) | `0.00% <0.00%> (ø)` | | | ... and [109 more](https://codecov.io/gh/JuliaSmoothOptimizers/HSL.jl/pull/174?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=JuliaSmoothOptimizers) | |:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.