jamulussoftware / jamulussoftware/jamulus

JSON-RPC - Change method names to remove redundancy

Offen
#2,487 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
JSON-RPC refactoring
Vorherrschende Sprache
C
Sterne
1.1k
Forks
248
Ø Merge
2 T. 3 Std.
Gemergte PRs (30 T.)
9

Beschreibung

**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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Durchsuche die JSON-RPC-Implementierung nach den literalen Methoden jamulusserver/setServerName und jamulusserver/getServerProfile und ermittle anschließend deren zugehörige TODO-Dokumentation. Benenne die Methoden überall dort, wo sie definiert oder referenziert werden, in setName und getProfile um, aktualisiere die zugehörige Dokumentation und überprüfe, dass keine alten Methodennamen verbleiben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
c
Bereich
api, documentation
Issue-Typ
Refactoring
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

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