walaj / SeqLib

C++ htslib/bwa-mem/fermi interface for interrogating sequence data
http://bioinformatics.oxfordjournals.org/content/early/2016/12/21/bioinformatics.btw741.full.pdf+html
Other
132 stars 36 forks source link

Improvement: Remove use of "__" reserved C++ prefix #9

Closed rob-p closed 8 years ago

rob-p commented 8 years ago

Hi all,

I'm very excited to see this project! I've had the experience of replacing BamTools with htslib + samtools in the past before to reap the substantial speed improvements it provides. Of course, the interface is not nearly as nice, and I miss the nice, clean, c++ interface provided by BamTools. SeqLib seems like a great solution to this tradeoff.

Anyway, on to my issue. The use of __ as a prefix is reserved in C and C++ for implementation and library-specific use. Therefore, it's highly desirable to avoid beginning variables, functions or methods with __ as a prefix. Though I'm sure there is likely no conflict at this point, it's best to observe this rule to avoid potential naming conflicts in the future (and because all such names are technically reserved for the language).

--Rob

walaj commented 8 years ago

Hi Rob,

Very good to hear you're finding this project useful! Will be nice to have more users to continue to exercise and improve the code.

You make a good point about the naming convention, I've had others suggest I move away from it. Thanks for the link. It seems they suggest to avoid in general. I made some other changes, and removed most of the while I was at it.