gbif / tech-docs

This is an integrated technical documentation site for GBIF.org
https://techdocs.gbif.org
0 stars 2 forks source link

Improve definition for GBIF-field 'species' based in GbifTerm #90

Open CecSve opened 1 month ago

CecSve commented 1 month ago

Feedback on Occurrence download formats (Github source for this page)

In the simple download table, the definition of species is somewhat limited and for all ranks it is just repeated. Ideally, the species column definition should be updated to correspond to the GbifTerm:

The canonical name without authorship of the accepted species.

Instead of the generic:

The species name (excluding authorship) for the species from the GBIF backbone matched to this occurrence.

Or at least it should be clear that it is the accepted species name.

The table is not editable in the tech docs repo and seems to link to a source I cannot find

# Fetch species list format download terms
write_description_table(GBIF_API + '/occurrence/download/describe/speciesList',
                        lambda x : x['fields'],
                        'speciesList',
                        True,
                        output+"/download-species-list-terms-table.adoc",
                        text_types)
MattBlissett commented 1 month ago

The source for this is Occurrence.java in the gbif-api project, as it's drawn from the API definitions.

I'll align GbifTerm and Occurrence later, they ought to be consistent for all terms.