Documentation: serial_write() requires literal "\n", not newline character(s)

Aperta
#16 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Start with the serial_write() API reference linked in the issue and check how examples or related documentation describe line endings. Document that it processes a literal \n, not newline characters; the issue is done when this behavior is clearly stated in the API reference or an example.

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

Descrizione

May be worth mentioning that the code for serial_write() is looking for literal \\n to process/write to the Serial Monitor.

This could be exposed in an example or the API reference.

API Ref: https://wokwi.github.io/wokwi-python-client/reference/wokwi_client/#wokwi_client.WokwiClient.serial_write

Lingua principale
Python
Stelle
10
Fork
5
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.