andim / pyrepseq

Python library for immune repertoire analysis
MIT License
15 stars 4 forks source link

Gene standardisation in standardise_dataframe, +docstring +unit tests #1

Closed yutanagano closed 1 year ago

andim commented 1 year ago

Hi Yuta,

This is great and looks ready to be merged!

I am using numpydoc style docstrings in most of the rest of pyrepseq and I am wondering whether these happily co-exist with reST style docstrings? (see https://stackoverflow.com/questions/3898572/what-are-the-most-common-python-docstring-formats)

We can either merge as is, or we could rewrite the docstring using numpydoc conventions. I don't have strong feelings either way, I just wanted to flag it up to get your input.

Andreas

yutanagano commented 1 year ago

Yes very good point- I admit I wasn't paying enough attention to the other docstrings. I think if you are already using numpy style docstrings we might as well keep it consistent that way! I will quickly change the docstring and push and update.

yutanagano commented 1 year ago

Fixed!