Update documentation for updated DWC basis of record values.

gbif/pipelines#635
gbif · Jan 25, 2022 · 110e0cb · 110e0cb
1 parent 40704fc
commit 110e0cb
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/README.rst b/README.rst
@@ -112,7 +112,7 @@ Example usage:
     occ.search(taxonKey = 3329049)
     occ.get(key = 252408386)
     occ.count(isGeoreferenced = True)
-    occ.download('basisOfRecord = LITERATURE')
+    occ.download('basisOfRecord = PRESERVED_SPECIMEN')
     occ.download('taxonKey = 3119195')
     occ.download('decimalLatitude > 50')
     occ.download_list(user = "sckott", limit = 5)

diff --git a/docs/modules/occurrence.rst b/docs/modules/occurrence.rst
@@ -30,7 +30,7 @@ Example usage:
     occ.search(taxonKey = 3329049)
     occ.get(key = 1986559641)
     occ.count(isGeoreferenced = True)
-    occ.download('basisOfRecord = LITERATURE')
+    occ.download('basisOfRecord = PRESERVED_SPECIMEN')
     occ.download('taxonKey = 3119195')
     occ.download('decimalLatitude > 50')
     occ.download_list(user = "sckott", limit = 5)

diff --git a/pygbif/maps/map.py b/pygbif/maps/map.py
@@ -72,12 +72,12 @@ def map(
 
        - ``FOSSIL_SPECIMEN`` An occurrence record describing a fossilized specimen.
        - ``HUMAN_OBSERVATION`` An occurrence record describing an observation made by one or more people.
-       - ``LITERATURE`` An occurrence record based on literature alone.
-       - ``LIVING_SPECIMEN`` An occurrence record describing a living specimen, e.g.
+       - ``LIVING_SPECIMEN`` An occurrence record describing a living specimen.
        - ``MACHINE_OBSERVATION`` An occurrence record describing an observation made by a machine.
+       - ``MATERIAL_CITATION`` An occurrence record based on a reference to a scholarly publication.
        - ``OBSERVATION`` An occurrence record describing an observation.
+       - ``OCCURRENCE`` An existence of an organism at a particular place and time. No more specific basis.
        - ``PRESERVED_SPECIMEN`` An occurrence record describing a preserved specimen.
-       - ``UNKNOWN`` Unknown basis for the record.
 
     :param year: [int] The 4 digit year. A year of 98 will be interpreted as 
         AD 98. Supports range queries, smaller,larger (e.g., ``1990,1991``, 

diff --git a/pygbif/occurrences/download.py b/pygbif/occurrences/download.py
@@ -115,7 +115,7 @@ def download(queries, user=None, pwd=None, email=None, pred_type="and"):
 
         from pygbif import occurrences as occ
 
-        occ.download('basisOfRecord = LITERATURE')
+        occ.download('basisOfRecord = PRESERVED_SPECIMEN')
         occ.download('taxonKey = 3119195')
         occ.download('decimalLatitude > 50')
         occ.download('elevation >= 9000')

diff --git a/pygbif/occurrences/search.py b/pygbif/occurrences/search.py
@@ -78,12 +78,12 @@ def search(
 
      - ``FOSSIL_SPECIMEN`` An occurrence record describing a fossilized specimen.
      - ``HUMAN_OBSERVATION`` An occurrence record describing an observation made by one or more people.
-     - ``LITERATURE`` An occurrence record based on literature alone.
-     - ``LIVING_SPECIMEN`` An occurrence record describing a living specimen, e.g.
+     - ``LIVING_SPECIMEN`` An occurrence record describing a living specimen.
      - ``MACHINE_OBSERVATION`` An occurrence record describing an observation made by a machine.
+     - ``MATERIAL_CITATION`` An occurrence record based on a reference to a scholarly publication.
      - ``OBSERVATION`` An occurrence record describing an observation.
+     - ``OCCURRENCE`` An existence of an organism at a particular place and time. No more specific basis.
      - ``PRESERVED_SPECIMEN`` An occurrence record describing a preserved specimen.
-     - ``UNKNOWN`` Unknown basis for the record.
 
     :param eventDate: [date] Occurrence date in ISO 8601 format: yyyy, yyyy-MM, yyyy-MM-dd, or
        MM-dd. Supports range queries, smaller,larger (e.g., ``1990,1991``, whereas ``1991,1990``