Koeng101 / Koeng101/dnadesign

Document LinearFold+mfe and make linters work

Open
#39 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
38
Forks
1
PR merge metrics
No merged PRs in 30d

Description

I merged much of linearfold directly from https://github.com/allyourbasepair/rbscalculator - and so, not only are the linters *very* unhappy, but there are lots of missing spots for better documentation (though vivek did very well in most of the code).

I am putting a documentation issue here: squash all linter bugs, add documentation and context for everything in the LinearFold+mfe packages, and generally clean it up to be up-to-spec with the rest of the project.

I am adding it now because I believe we need to get it into the tree, then can begin improvements in an iterative process.

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the LinearFold and mfe packages, then run the project's linters to identify the reported problems. Done means the linter issues are resolved and the packages have documentation and context consistent with the rest of the project.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
bioinformatics, documentation, tooling
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.