Skip to content

Commit

Permalink
update doc and test
Browse files Browse the repository at this point in the history
  • Loading branch information
Zilong-Li committed Sep 26, 2024
1 parent 2efd1c7 commit 915c6c1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
1 change: 0 additions & 1 deletion test/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,3 @@ test:
./bcf-reader.bin --success
./bcf-writer.bin --success
./bcf-variant.bin --success
./example.bin --success
12 changes: 6 additions & 6 deletions vcfpp.h
Original file line number Diff line number Diff line change
Expand Up @@ -1648,10 +1648,10 @@ class BcfReader
/**
* @brief query the status of a given region in the VCF
* @return -2: the region is not a valid bcftools-like format,
or it is not presenting in the VCF even though it's bcftols-like format.
-1: there is no index file found.
0: the region is valid but empty.
1: vaild and not empty.
* or it is not presenting in the VCF even though it's bcftols-like format. \n
* -1: there is no index file found. \n
* 0: the region is valid but empty. \n
* 1: vaild and not empty. \n
*/
int getStatus(const std::string & region)
{
Expand All @@ -1674,8 +1674,8 @@ class BcfReader

/**
* @brief count the number of variants by iterating through a given region.
* @note If you want to continue work on that region, remember to reset the region by setRegion!
Also, check the status of the region first to handle the different cases
* @note If you want to continue work on that region, remember to reset the region by setRegion()! \n
* Also, check the status of the region first to handle the different cases!
*/
int getVariantsCount(const std::string & region)
{
Expand Down

0 comments on commit 915c6c1

Please sign in to comment.