Skip to content

Commit 1f82cb9

Browse files
jackturpsdaviesrob
andauthored
Fix a documentation spelling error (#1972)
* Change hts_base_mode_state_free to hts_base_mod_state_free in the hts_base_mod_state_alloc documentation so it refers to the correct function. * Fix additional instances of "hts_base_mode_" typo - should be "hts_base_mod_". --------- Co-authored-by: Rob Davies <[email protected]>
1 parent 0c6c30b commit 1f82cb9

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

htslib/sam.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2236,25 +2236,25 @@ typedef struct hts_base_mod {
22362236
// Flags for bam_parse_basemod2
22372237
#define HTS_MOD_REPORT_UNCHECKED 1
22382238

2239-
/// Allocates an hts_base_mode_state.
2239+
/// Allocates an hts_base_mod_state.
22402240
/**
2241-
* @return An hts_base_mode_state pointer on success,
2241+
* @return An hts_base_mod_state pointer on success,
22422242
* NULL on failure.
22432243
*
22442244
* This just allocates the memory. The initialisation of the contents is
22452245
* done using bam_parse_basemod. Successive calls may be made to that
22462246
* without the need to free and allocate a new state.
22472247
*
2248-
* The state be destroyed using the hts_base_mode_state_free function.
2248+
* The state be destroyed using the hts_base_mod_state_free function.
22492249
*/
22502250
HTSLIB_EXPORT
22512251
hts_base_mod_state *hts_base_mod_state_alloc(void);
22522252

2253-
/// Destroys an hts_base_mode_state.
2253+
/// Destroys an hts_base_mod_state.
22542254
/**
22552255
* @param state The base modification state pointer.
22562256
*
2257-
* The should have previously been created by hts_base_mode_state_alloc.
2257+
* The should have previously been created by hts_base_mod_state_alloc.
22582258
*/
22592259
HTSLIB_EXPORT
22602260
void hts_base_mod_state_free(hts_base_mod_state *state);

0 commit comments

Comments
 (0)