bluerobotics / bluerobotics/ping-python

Documentation error

Aperta
#126 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
60
Fork
39
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

On https://docs.bluerobotics.com/ping-python/classbrping_1_1ping1d_1_1Ping1D.html

For the returns section in set commands
If verify is False, True on successful communication with the device. If verify is False, True if the new device parameters are verified to have been written correctly. False otherwise (failure to read values back or on verification failure)

Shouldn't the second one be If verify is True.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Apri la documentazione collegata dell’API Ping1D ed esamina la sezione sui valori restituiti per i comandi set. Correggi la seconda condizione in modo che si riferisca al fatto che verify sia True, quindi conferma che il testo renderizzato distingua i casi verify=True e verify=False.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.