update documentation with cffi '\r' error

[ctb]

if you get a cffi error around '\r', you might need to make autocrlf false, per these docs

This error can be reproduced by some using this set of commands:

put

[core]
    autocrlf = true

in your .gitconfig on a linux box, then:

%  conda create -n sourmash_dev python=3.7 pip rust
%  conda activate sourmash_dev
% git clone https://github.com/dib-lab/sourmash.git
% cd sourmash
% pip install -e .
...
     File "/home/ctbrown/miniconda3/envs/sourmash_dev/lib/python3.7/site-packages/cffi/cparser.py", line 336, in convert_pycparser_error
        raise CDefError(msg)
    cffi.CDefError: cannot parse ""
    <cdef source string>:1:2: Illegal character '\r'
    ----------------------------------------
ERROR: Command errored out with exit status 1: /home/ctbrown/miniconda3/envs/sourmash_dev/bin/python3.7 -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/sourmash_foo/sourmash/setup.py'"'"'; __file__='"'"'/tmp/sourmash_foo/sourmash/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' develop --no-deps Check the logs for full command output.

I think this should also be fixed in cffi...

[ctb]

this looks like the home of the cffi project? https://foss.heptapod.net/pypy/cffi

[luizirber]

yup

[ctb]

this seems to no longer happen :)