docs(network): TSDoc says ICE_SERVERS defaults to an empty list, the code uses public STUN servers

Aperta Adatta ai principianti
#509 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript

Direzione di ricerca

Leggi modules/network/src/shared/config.network.ts:55 e confronta il relativo decorator con il TSDoc; controlla docs/docs/network/index.mdx:105 per il valore predefinito documentato. Aggiorna il TSDoc per indicare il valore predefinito del server STUN pubblico e spiegare che ICE_SERVERS= disattiva l’opzione con un elenco vuoto. Il lavoro è concluso quando il riferimento API corrisponde al codice e documenta la disattivazione.

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

Descrizione

documentation good first issue modules:network
What is the type of issue?

Documentation is incorrect

What is the issue?

The TSDoc says @default [], but the decorator uses DEFAULT_NANOFORGE_ICE_SERVERS (7 public STUN servers). A user who wants no third-party STUN servers (privacy, offline LAN) is told the wrong default by the API reference. docs/docs/network/index.mdx:105 gives the right default.

Evidence:

 * @default []
@Default(DEFAULT_NANOFORGE_ICE_SERVERS)

Suggested fix: Document the real default and how to opt out (ICE_SERVERS= → []).

Found during a code audit of main at be72076.

Where did you find it?
Lingua principale
TypeScript
Stelle
7
Fork
2
Merge medio
1g 17h
PR unite (30g)
17

Preparare l'ambiente

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.

Altre issue di NanoForge-dev/Engine

Tutte le issue di NanoForge-dev/Engine

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.