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

Add proper documentation to MadNLP #176

Merged
merged 6 commits into from
Jun 14, 2022
Merged

Add proper documentation to MadNLP #176

merged 6 commits into from
Jun 14, 2022

Conversation

frapac
Copy link
Collaborator

@frapac frapac commented Jun 13, 2022

First stab

@frapac frapac requested a review from sshin23 June 13, 2022 18:10
Copy link
Member

@sshin23 sshin23 left a comment

Choose a reason for hiding this comment

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

Great work, @frapac! I love what you did in solver.md and kkt.md. I'll merge it right away after fixing the URL typo

docs/make.jl Outdated
)

deploydocs(
repo = "github.com/exanauts/MadNLP.jl.git",
Copy link
Member

Choose a reason for hiding this comment

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

url should be github.com/MadNLP/MadNLP.jl.git

Copy link
Member

Choose a reason for hiding this comment

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

also in line 11

@codecov-commenter
Copy link

codecov-commenter commented Jun 14, 2022

Codecov Report

Merging #176 (c92758f) into master (5f0a21d) will decrease coverage by 0.19%.
The diff coverage is n/a.

❗ Current head c92758f differs from pull request most recent head 7b67004. Consider uploading reports for the commit 7b67004 to get more accurate results

@@            Coverage Diff             @@
##           master     #176      +/-   ##
==========================================
- Coverage   75.12%   74.93%   -0.20%     
==========================================
  Files          38       38              
  Lines        3405     3351      -54     
==========================================
- Hits         2558     2511      -47     
+ Misses        847      840       -7     
Impacted Files Coverage Δ
src/KKT/KKTsystem.jl 97.22% <ø> (-0.08%) ⬇️
src/LinearSolvers/linearsolvers.jl 0.00% <ø> (ø)
lib/MadNLPPardiso/src/pardisomkl.jl 90.62% <0.00%> (-3.23%) ⬇️
src/utils.jl 62.50% <0.00%> (-2.21%) ⬇️
src/options.jl 84.61% <0.00%> (-1.10%) ⬇️
src/matrixtools.jl 85.07% <0.00%> (-0.44%) ⬇️
lib/MadNLPMumps/src/MadNLPMumps.jl 82.92% <0.00%> (-0.41%) ⬇️
lib/MadNLPHSL/src/ma57.jl 75.40% <0.00%> (-0.40%) ⬇️
lib/MadNLPHSL/src/ma97.jl 84.00% <0.00%> (-0.32%) ⬇️
lib/MadNLPHSL/src/ma86.jl 84.90% <0.00%> (-0.28%) ⬇️
... and 8 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 5f0a21d...7b67004. Read the comment docs.

@sshin23 sshin23 merged commit 12d20a0 into master Jun 14, 2022
@frapac
Copy link
Collaborator Author

frapac commented Jun 14, 2022

Thanks for the feedback @sshin23 !

@sshin23 sshin23 deleted the fp/documentation branch July 5, 2022 15:06
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.

3 participants