holgern / pyedflib

pyedflib is a python library to read/write EDF+/BDF+ files based on EDFlib.
http://pyedflib.readthedocs.org/
BSD 3-Clause "New" or "Revised" License
209 stars 121 forks source link

gender → sex? #207

Closed DimitriPapadopoulos closed 1 year ago

DimitriPapadopoulos commented 1 year ago

Although sex might be perceived as offensive in other contexts, in the context of life sciences it must be used instead of gender, where appropriate. The EDF+ specification is clear about it:

- sex (English, so F or M).

Would you agree to fix this, if backwards compatibility is assured and tested, of course?

DimitriPapadopoulos commented 1 year ago

See: https://gitlab.com/Teuniz/EDFlib/-/issues/12

skjerns commented 1 year ago

if this is implemented in upstream edflib, surely we'll change this as well.

skjerns commented 1 year ago

Proposal: Change all functions to use "sex" instead of "gender", but keep previous functions with DeprecationWarning.

DimitriPapadopoulos commented 1 year ago

I could copy the latest versions of edflib.h and edflib.h from EDFlib, but I understand you have slightly modified them. What would you suggest?

skjerns commented 1 year ago

I could copy the latest versions of edflib.h and edflib.h from EDFlib, but I understand you have slightly modified them. What would you suggest?

indeed, there are some modifications which make it hard to simply update. For now we could either only adapt it in the python code or additionally integrate the changes in the C files into the current code base.

It's a bit unfortunate that the C files are altered so much. Maybe in the future we should think about keeping the original C/h files in our code base and only do alterations in the Python files, or as additional C files

DimitriPapadopoulos commented 1 year ago

We can keep the C files as they are for now. They are not visible by end users.