Add OLS.Linear.Univariable.fitWithWeighting to documentation

Open Beginner friendly
#385 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
fsharp
Domain
documentation

Research direction

Start with the API reference and the existing Simple Linear Regression code example. Check how nearby functions are documented and how examples are structured; done when fitWithWeighting appears in the API reference and is included in the example with usable guidance.

Written by the indexing model from the issue text.

Description

Documentation

The function OLS.Linear.Univariable.fitWithWeighting was recently merged with PR #369.
I think it makes sense to add it into the documentation in the future so users know it's available and how to use it.

Suggested changes:

  • Update API reference
  • Add function to the existing Simple Linear Regression code example
Dominant language
F#
Stars
227
Forks
58
Avg merge
55m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from fslaborg/FSharp.Stats

All issues in fslaborg/FSharp.Stats

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.