Skip to content

Commit

Permalink
added package level doc strings. (#441)
Browse files Browse the repository at this point in the history
* added package level doc strings.
  • Loading branch information
TimothyStiles authored Jan 31, 2024
1 parent 2328911 commit f18c391
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions search/bwt/bwt.go
Original file line number Diff line number Diff line change
@@ -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 (
Expand Down
8 changes: 8 additions & 0 deletions search/search.go
Original file line number Diff line number Diff line change
@@ -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.
*/

0 comments on commit f18c391

Please sign in to comment.