JuliaSmoothOptimizers / JuliaSmoothOptimizers/PartiallySeparableNLPModels.jl

Add constructors documentation in docstrings

Open
#73 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Julia
Stars
9
Forks
4
PR merge metrics
No merged PRs in 30d

Description

I noted most of the structures involved in #72 have a docstring, which is great! For instance https://github.com/JuliaSmoothOptimizers/PartiallySeparableNLPModels.jl/blob/3266fd6f0ed18a3ae1aad6e4ad11249ee99b9296/src/partitionedNLPModels/PBFGSNLPModels.jl#L11

I think it would be even better if the constructors available for the structure would be documented as well.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.