diff --git a/CHANGELOG.md b/CHANGELOG.md index 01c65dab..6e38bcc5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.31.1] - 2024-01-31 + +### Added +- Fixed package level doc strings for search and bwt packages. + +[0.31.0]: https://github.com/TimothyStiles/poly/releases/tag/v0.31.0 + ## [0.31.0] - 2024-01-31 ### Added diff --git a/search/bwt/bwt.go b/search/bwt/bwt.go index 3d01c03b..fedce400 100644 --- a/search/bwt/bwt.go +++ b/search/bwt/bwt.go @@ -1,3 +1,13 @@ +/* +Package bwt is a package for performing burrows-wheeler transforms on sequences. + +The BWT is a lossless compression algorithm that can be used to reduce the memory +footprint of a sequence while still maintaining the ability to search, align, and +extract the original sequence. This is useful for sequences so large that it would +be beneficial to reduce its memory footprint while also maintaining a way to analyze +and work with the sequence. BWT is used in both bioinformatics(burrows wheeler alignment) +and data compression (bzip2). +*/ package bwt import ( diff --git a/search/search.go b/search/search.go new file mode 100644 index 00000000..7388d132 --- /dev/null +++ b/search/search.go @@ -0,0 +1,8 @@ +/* +Package search provides utilities for searching sequence data. +*/ +package search + +/* +This package is supposed to be empty and only exists to provide a doc string. +*/