Skip to content

Fix extra space generated by "generate_json_rpc_docs.py" #3737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dingodoppelt wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −8
Open

Fix extra space generated by "generate_json_rpc_docs.py" #3737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/JSON-RPC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Results:

### jamulusclient/setFaderLevel

Sets the fader level. Example: {"id":1,"jsonrpc":"2.0","method":"jamulusclient/setFaderLevel","params":{"channelIndex": 0,"level": 50}}.
Sets the fader level. Example: {"id":1,"jsonrpc":"2.0","method":"jamulusclient/setFaderLevel","params":{"channelIndex": 0,"level": 50}}.

Parameters:

Expand Down Expand Up @@ -391,7 +391,7 @@ Results:
| result.countryId | number | The server country ID (see QLocale::Country). |
| result.welcomeMessage | string | The server welcome message. |
| result.directoryType | string | The directory type as a string (see EDirectoryType and SerializeDirectoryType). |
| result.directoryAddress | string | The string used to look up the directory address (only assume valid if directoryType is "custom" and registrationStatus is "registered"). |
| result.directoryAddress | string | The string used to look up the directory address (only assume valid if directoryType is "custom" and registrationStatus is "registered"). |
| result.directory | string | The directory with which this server requested registration, or blank if none. |
| result.registrationStatus | string | The server registration status as string (see ESvrRegStatus and SerializeRegistrationStatus). |

Expand All @@ -410,7 +410,7 @@ Results:

| Name | Type | Description |
| --- | --- | --- |
| result | string | Always "acknowledged". To check if the recording was restarted or if there is any error, call `jamulusserver/getRecorderStatus` again. |
| result | string | Always "acknowledged". To check if the recording was restarted or if there is any error, call `jamulusserver/getRecorderStatus` again. |


### jamulusserver/setDirectory
Expand Down Expand Up @@ -445,7 +445,7 @@ Results:

| Name | Type | Description |
| --- | --- | --- |
| result | string | Always "acknowledged". To check if the directory was changed, call `jamulusserver/getRecorderStatus` again. |
| result | string | Always "acknowledged". To check if the directory was changed, call `jamulusserver/getRecorderStatus` again. |


### jamulusserver/setServerName
Expand Down Expand Up @@ -496,7 +496,7 @@ Results:

| Name | Type | Description |
| --- | --- | --- |
| result | string | Always "acknowledged". To check if the recording was enabled, call `jamulusserver/getRecorderStatus` again. |
| result | string | Always "acknowledged". To check if the recording was enabled, call `jamulusserver/getRecorderStatus` again. |


### jamulusserver/stopRecording
Expand All @@ -513,7 +513,7 @@ Results:

| Name | Type | Description |
| --- | --- | --- |
| result | string | Always "acknowledged". To check if the recording was disabled, call `jamulusserver/getRecorderStatus` again. |
| result | string | Always "acknowledged". To check if the recording was disabled, call `jamulusserver/getRecorderStatus` again. |


## Notification reference
Expand All @@ -525,7 +525,7 @@ Parameters:

| Name | Type | Description |
| --- | --- | --- |
| params.channelLevelList | array | The channel level list. Each item corresponds to the respective client retrieved from the jamulusclient/clientListReceived notification. |
| params.channelLevelList | array | The channel level list. Each item corresponds to the respective client retrieved from the jamulusclient/clientListReceived notification. |
| params.channelLevelList[*] | number | The channel level, an integer between 0 and 9. |


Expand Down
2 changes: 1 addition & 1 deletion tools/generate_json_rpc_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ def to_markdown(self):
current_item.handle_tag("result")
current_item.handle_text(line[len("/// @result "):])
elif line.startswith("///"):
current_item.handle_text(line[len("///"):])
current_item.handle_text(line[len("///") + 1:])
elif line == "":
pass
else:
Expand Down
Loading