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

fix missing doc lints in tests #37

Merged
merged 4 commits into from
Dec 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "varpro"
version = "0.10.0"
version = "0.10.1"
authors = ["geo-ant"]
edition = "2021"
license = "MIT"
Expand Down
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,12 @@
[![crates](https://img.shields.io/crates/v/varpro)](https://crates.io/crates/varpro)
[![Coverage Status](https://coveralls.io/repos/github/geo-ant/varpro/badge.svg?branch=main)](https://coveralls.io/github/geo-ant/varpro?branch=main)
![maintenance-status](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
[![crates](https://raw.githubusercontent.com/geo-ant/user-content/refs/heads/main/ko-fi-support.svg)](https://ko-fi.com/geoant)

Nonlinear function fitting made simple. This library provides robust and fast
least-squares fitting of a wide class of model functions to data.
It uses the VarPro algorithm to achieve this, hence the name.

## Support

If you like this crate, recommend it to others. You can also [buy me a coffee](https://ko-fi.com/geoant)
if you feel like it.

## Introduction

This crate implements a powerful algorithm to fit model functions to data,
Expand Down
1 change: 1 addition & 0 deletions src/model/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ pub mod errors;
pub mod builder;
mod model_basis_function;
#[cfg(any(test, doctest))]
#[allow(missing_docs)]
pub mod test;

/// Represents an abstraction for a separable nonlinear model
Expand Down
1 change: 1 addition & 0 deletions src/test_helpers/mod.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#![allow(missing_docs)]
pub mod differentiation;

use nalgebra::{DVector, Scalar};
Expand Down
Loading