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

cleanup of codes and docs #625

Merged
merged 4 commits into from
Mar 11, 2022
Merged

cleanup of codes and docs #625

merged 4 commits into from
Mar 11, 2022

Conversation

StevellM
Copy link
Collaborator

@StevellM StevellM commented Mar 9, 2022

This is supposed to end the improvement of the test coverage for hermitian spaces/lattices and do a little preparation for the html documentation (c.f. #557 ).
I have done some cleanups on some codes in the ~/QuadForm/Herm/ repository, and I started to develop more the documentation and making it more consistent. I focused mainly on what I want to treat in the html documentation at first (i.e. hermitian spaces/lattices) so the changes are mostly regarding functions about hermitian world. Nonetheless, I have modified also few things in ~/QuadForm/ and ~/QuadForm/Quad/ where I have found something to change.
There is a final test for genus representatives of hermitian lattices supposed to catch a some part of the code not covered previously.
I am not strict on the documentation, I have tried to do as precised and clear possible but this can still be modified, of course.

@thofma
Copy link
Owner

thofma commented Mar 9, 2022

Thanks. This looks good!

@StevellM
Copy link
Collaborator Author

StevellM commented Mar 9, 2022

Great. I have seen other typos I will have to correct. However, I don't understand that the tests fail: while running the Hecke.test_module function I had the same problems, but on the REPL the tests are ok.

@thofma
Copy link
Owner

thofma commented Mar 9, 2022

The tests are run with Hecke.assertions(true).

@codecov
Copy link

codecov bot commented Mar 10, 2022

Codecov Report

Merging #625 (65b25c8) into master (24543d0) will decrease coverage by 0.07%.
The diff coverage is 87.75%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #625      +/-   ##
==========================================
- Coverage   70.34%   70.27%   -0.08%     
==========================================
  Files         314      314              
  Lines       92353    92337      -16     
==========================================
- Hits        64967    64889      -78     
- Misses      27386    27448      +62     
Impacted Files Coverage Δ
src/QuadForm/Herm/Lattices.jl 98.09% <ø> (ø)
src/QuadForm/Herm/Legacy.jl 95.23% <ø> (ø)
src/QuadForm/Herm/LocallyIsometricSublattice.jl 91.54% <ø> (ø)
src/QuadForm/Herm/Mass.jl 91.54% <ø> (ø)
src/QuadForm/Herm/Spaces.jl 94.73% <ø> (ø)
src/QuadForm/Herm/Types.jl 100.00% <ø> (+85.71%) ⬆️
src/QuadForm/Lattices.jl 82.66% <ø> (ø)
src/QuadForm/Quad/Lattices.jl 98.89% <ø> (ø)
src/QuadForm/Quad/Spaces.jl 89.92% <ø> (ø)
src/QuadForm/Herm/Genus.jl 93.82% <86.95%> (+1.19%) ⬆️
... and 29 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 24543d0...65b25c8. Read the comment docs.

@StevellM StevellM marked this pull request as ready for review March 10, 2022 12:25
@thofma thofma merged commit 34ebcd5 into thofma:master Mar 11, 2022
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