NLPModels.jl icon indicating copy to clipboard operation
NLPModels.jl copied to clipboard

use strict=true in docs

Open dpo opened this issue 3 years ago • 7 comments

dpo avatar Aug 03 '22 22:08 dpo

Codecov Report

Patch and project coverage have no change.

Comparison is base (0b36c4f) 99.50% compared to head (423556f) 99.50%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #411   +/-   ##
=======================================
  Coverage   99.50%   99.50%           
=======================================
  Files          13       13           
  Lines         802      803    +1     
=======================================
+ Hits          798      799    +1     
  Misses          4        4           
Impacted Files Coverage Δ
src/NLPModels.jl 100.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov[bot] avatar Aug 03 '22 22:08 codecov[bot]

This fails because of #409 as ADNLPModels has not reached up-to-date NLPModels release.

tmigot avatar Aug 03 '22 23:08 tmigot

Package name latest stable
ADNLPModels.jl
AmplNLReader.jl
CUTEst.jl
CaNNOLeS.jl
DCISolver.jl
FletcherPenaltySolver.jl
JSOSolvers.jl
LLSModels.jl
NLPModelsIpopt.jl
NLPModelsJuMP.jl
NLPModelsModifiers.jl
NLPModelsTest.jl
PDENLPModels.jl
Percival.jl
QuadraticModels.jl
SolverBenchmark.jl
SolverCore.jl
SolverTest.jl
SolverTools.jl

github-actions[bot] avatar Aug 16 '22 22:08 github-actions[bot]

So, the error comes from duplicate documentation.

The autodocs block in the references page print all the docstrings. However, in pages like: https://juliasmoothoptimizers.github.io/NLPModels.jl/dev/models/ https://juliasmoothoptimizers.github.io/NLPModels.jl/dev/tools/ https://juliasmoothoptimizers.github.io/NLPModels.jl/dev/api/ https://juliasmoothoptimizers.github.io/NLPModels.jl/dev/internals/ we also call some docstring.

I see two solutions:

  • we remove the docstrings from this page.
  • we replace the docstrings by links to the reference page.

@dpo @abelsiqueira Any idea or opinion?

tmigot avatar Aug 16 '22 23:08 tmigot

we replace the docstrings by links to the reference page.

dpo avatar Aug 16 '22 23:08 dpo

Package name latest stable
ADNLPModels.jl
AmplNLReader.jl
CUTEst.jl
CaNNOLeS.jl
DCISolver.jl
JSOSolvers.jl
LLSModels.jl
NLPModelsIpopt.jl
NLPModelsJuMP.jl
NLPModelsModifiers.jl
NLPModelsTest.jl
PDENLPModels.jl
Percival.jl
QuadraticModels.jl
SolverBenchmark.jl
SolverCore.jl
SolverTest.jl
SolverTools.jl

github-actions[bot] avatar Aug 17 '22 13:08 github-actions[bot]

https://juliasmoothoptimizers.github.io/NLPModels.jl/previews/PR411/

tmigot avatar Aug 17 '22 13:08 tmigot