Make `bcf_hdr_parse()` public

Open
#359 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
50/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
c
Domain
api

Research direction

Start in vcf.h at the bcf_hdr_parse() declaration and inspect how public functions are exposed in the surrounding API. Make the function available to third-party applications rather than marking it internal-only, then verify that the library still builds and the public declaration is usable.

Written by the indexing model from the issue text.

Description

vcf.h contains:

/** The following functions are for internal use and should rarely be called directly */
int bcf_hdr_parse(bcf_hdr_t *hdr, char *htxt);

It would be nice if bcf_hdr_parse() was available to third party applications as a straightforward way to construct headers. Could it be moved from internal-use-only?

Apologies: this issue was originally posted to the bcftools issue tracker by mistake.

Dominant language
C
Stars
950
Forks
475
Avg merge
3d 13h
Merged PRs (30d)
11

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from samtools/htslib

All issues in samtools/htslib

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.