jamulussoftware / jamulussoftware/jamulus

JSON-RPC - Change method names to remove redundancy

Aperta
#2,487 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

JSON-RPC refactoring
Lingua principale
C
Stelle
1.1k
Fork
248
Merge medio
2g 3h
PR unite (30g)
9

Descrizione

**What is the current behaviour and why should it be changed?**

Methods _jamulusserver/setServerName_ and _jamulusserver/getServerProfile_ are redundant in their naming. Propose changing to _setName_ and _getProfile_, respectively.

Given the experimental state of JSON-RPC code, this change can be done without notice.

**Describe possible approaches**

Simple changes to method name literals in code and changes to associated (TODO) documentation.

**Has this feature been discussed and generally agreed?**

No

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Cerca nell’implementazione JSON-RPC i metodi letterali jamulusserver/setServerName e jamulusserver/getServerProfile, quindi individua la documentazione TODO associata. Rinomina i metodi in setName e getProfile ovunque siano definiti o referenziati, aggiorna la documentazione correlata e verifica che non rimangano i vecchi nomi dei metodi.

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

Valutazione

Stack tecnologico
c
Ambito
api, documentation
Tipo di issue
Refactoring
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.