added package level doc strings.

bebop · Jan 31, 2024 · c70c32d · c70c32d
1 parent 2328911
commit c70c32d
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git 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
@@ -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.
+*/