JuliaGaussianProcesses / JuliaGaussianProcesses/LinearMixingModels.jl

Improve documentation

Open
#22 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
5
Forks
0
PR merge metrics
No merged PRs in 30d

Description

To add:

  • API.md
  • example.md
  • Update README
  • more...?

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reviewing the existing README and the documentation checklist in this issue, then inspect the project to determine what API.md and example.md should cover. Done means adding the requested documentation and resolving the remaining checklist items, including deciding whether the “more...?” item has a concrete scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.