dropbox / dropbox/dropbox-sdk-python

Incorrect documentation regarding errors during files_batch* requests

Offen
#111 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
bug
Vorherrschende Sprache
Python
Sterne
983
Forks
330
Ø Merge
3 Min.
Gemergte PRs (30 T.)
10

Beschreibung

Hey there,

We're using files_move_batch and files_move_batch_check. Talking to support, they've acknowledge that transient errors can occur during either of these two calls requiring a nominal back-off retry. While try/excepting these conditions, the documentation says that ApiError.reason carries the domain-specific error and in our case the error would be dropbox.files.PollError.

Neither of these cases are accurate: ApiError.**error** contains the error (there is no 'reason' member) and dropbox.**async**.PollError was returned, not dropbox.files.PollError.

We're using dropbox 7.2.1 but I've just checked 7.3.1 docs and the inconsistency remains:
>If this raises, ApiError.reason is of type:
> dropbox.files.PollError

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start by locating the documentation for files_move_batch and files_move_batch_check, then verify the documented ApiError member and PollError module against the SDK behavior described. Done means the text names ApiError.error and dropbox.async.PollError consistently.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.