jamulussoftware / jamulussoftware/jamulus

JSON-RPC - Change method names to remove redundancy

Open
#2,487 5 comments 0 reactions 0 assignees View on GitHub
JSON-RPC refactoring
Dominant language
C
Stars
1.1k
Forks
248
Avg merge
2d 3h
Merged PRs (30d)
9

Description

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

Contributor guide

Open the contributing guide

Research direction

Search the JSON-RPC implementation for the literal methods jamulusserver/setServerName and jamulusserver/getServerProfile, then locate their associated TODO documentation. Rename the methods to setName and getProfile wherever they are defined or referenced, update the related documentation, and verify that no old method names remain.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
api, documentation
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.