Skip to content

Commit

Permalink
docs: Use modules link in the documentation index page
Browse files Browse the repository at this point in the history
Module docs contain more information (and more content is supposed to be
added in the future) than the documentation of the structs themselves.
  • Loading branch information
pnevyk committed Jan 8, 2022
1 parent d0f7421 commit 53320da
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,13 @@
//!
//! ## Algorithms
//!
//! * [Trust region](solver::TrustRegion) -- Recommended method to be used as a
//! * [Trust region](solver::trust_region) -- Recommended method to be used as a
//! default and it will just work in most of the cases.
//! * [Cuckoo search](solver::Cuckoo) -- A global optimization algorithm useful
//! * [Cuckoo search](solver::cuckoo) -- A global optimization algorithm useful
//! for initial guesses search in combination with a numerical solver.
//! * [Nelder-Mead](solver::NelderMead) -- Not generally recommended, but may be
//! useful for low-dimensionality problems with ill-defined Jacobian matrix.
//! * [Nelder-Mead](solver::nelder_mead) -- Not generally recommended, but may
//! be useful for low-dimensionality problems with ill-defined Jacobian
//! matrix.
//!
//! ## Problem
//!
Expand Down

0 comments on commit 53320da

Please sign in to comment.