Skip to content

Commit f18c391

Browse files
added package level doc strings. (#441)
* added package level doc strings.
1 parent 2328911 commit f18c391

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.31.1] - 2024-01-31
9+
10+
### Added
11+
- Fixed package level doc strings for search and bwt packages.
12+
13+
[0.31.0]: https://github.com/TimothyStiles/poly/releases/tag/v0.31.0
14+
815
## [0.31.0] - 2024-01-31
916

1017
### Added

search/bwt/bwt.go

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/*
2+
Package bwt is a package for performing burrows-wheeler transforms on sequences.
3+
4+
The BWT is a lossless compression algorithm that can be used to reduce the memory
5+
footprint of a sequence while still maintaining the ability to search, align, and
6+
extract the original sequence. This is useful for sequences so large that it would
7+
be beneficial to reduce its memory footprint while also maintaining a way to analyze
8+
and work with the sequence. BWT is used in both bioinformatics(burrows wheeler alignment)
9+
and data compression (bzip2).
10+
*/
111
package bwt
212

313
import (

search/search.go

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/*
2+
Package search provides utilities for searching sequence data.
3+
*/
4+
package search
5+
6+
/*
7+
This package is supposed to be empty and only exists to provide a doc string.
8+
*/

0 commit comments

Comments
 (0)