dnaio icon indicating copy to clipboard operation
dnaio copied to clipboard

s/d/_core.pyx: pedantic typo caught by linting.

Open emollier opened this issue 1 year ago • 2 comments
trafficstars

Debian's linting tool "lintian" reports the below informational message in dnaio 1.2.2 (and possibly other versions):

I: python3-dnaio: spelling-error-in-binary "allows to" "allows one to" [usr/lib/python3/dist-packages/dnaio/_core.cpython-312-x86_64-linux-gnu.so]

This patch applies almost blindly the recommendation, although perhaps there exists better wording to apply to the desctiption of the symbol. For what it's worth, I did attempt to find better wording, but lacking proper context for the function, the recommended change might do.

emollier avatar Oct 09 '24 19:10 emollier

This exception allows one to check some old paired-end reads that have IDs ending in '/1' and '/2'. Also, the fastq-dump tool (used for converting SRA files to FASTQ) appends '.1', '.2' and sometimes '.3' to paired-end reads if option -I is used.

I would replace this with

This is due to some FASTQ tools and basecallers appending 1, 2 or 3 to the read name to relay the pairing information.

Or something similarly concise. But I am curious to Marcel's opinion.

rhpvorderman avatar Oct 11 '24 06:10 rhpvorderman

I appreciate the new wording as to me it reads more clearly, in spite of dropping some specific historical information. I agree to wait for further opinions. :)

emollier avatar Oct 11 '24 11:10 emollier

Thanks, let’s just merge this as it is. Other improvements can be made separately.

marcelm avatar Oct 17 '24 09:10 marcelm