search

AntonOresten / VectorizedKmers.jl

Fast K-mer counting in Julia
https://AntonOresten.github.io/VectorizedKmers.jl/
MIT License
9 stars 0 forks source link

"K-mer" looks gross #13

Closed AntonOresten closed 1 year ago

AntonOresten commented 1 year ago

I've been using a capital K for the name of the package, in types, and in the documentation. The package name and types would be harder to read if the k was lowercase: "Vectorizedkmers", "AbstractkmerCountVector"

"K-mer" on the other hand, looks super gross! I went with it just to be consistent with the package and type names. In the README.md, I'm currently writing "$k$-mer" just to make the introduction more aesthetically pleasing, but it feels weird to use lowercase k in the documentation when it's uppercase in the code and in type names.

Proposed solution:

f*ck it. the package name can have an uppercase K. so can the types. the k variable could be lowercase, and so can it be in the docs. i haven't capitalized the k in variable names -- that's a line that i just don't cross, as i am a devout snake_caser.

AntonOresten commented 1 year ago

the proposed solution is being implemented in v0.2.0, see #12