BelgianBiodiversityPlatform / python-dwca-reader

🐍 A Python package to read Darwin Core Archive (DwC-A) files.
BSD 3-Clause "New" or "Revised" License
45 stars 21 forks source link

API inconsistency naming: DwCAReader.get_row_by_index() but CSVDataFile.get_row_by_position() #69

Closed niconoe closed 7 years ago

niconoe commented 7 years ago

!! When updating, also think of the docstrings, documentation, ...

niconoe commented 7 years ago

Fixed.

abubelinha commented 1 year ago

I am a bit confused with the documentation. I was going to ask about differences between the docs and the examples.
Perhaps there are two versions of the api, and the docs still contain examples of an old version?

i.e. dwca.core_file_location() vs dwca.descriptor.core.file_location

API docs: _dwca.core_filelocation

Pandas tutorial: _dwca.descriptor.core.filelocation

with DwCAReader('gbif-results.zip') as dwca:
   print("Core data file is: {}".format(dwca.descriptor.core.file_location)) # => 'occurrence.txt'

Thanks @abubelinha