Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix Array type in markdown

Browse Source
This commit is contained in:
Dominik Nakamura 2021-12-17 12:12:55 +09:00
parent 24cd95bca7
commit c6afc8f981
No known key found for this signature in database
GPG Key ID: E4C6A749B2491910
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs/generate_md.py
View File

@ -178,15 +178,17 @@ def get_requests(requests):
if request['requestFields']: if request['requestFields']:
ret += requestFieldHeader ret += requestFieldHeader
for requestField in request['requestFields']: for requestField in request['requestFields']:
valueType = requestField['valueType'].replace('<', "&lt;").replace('>', "&gt;")
valueRestrictions = requestField['valueRestrictions'] if requestField['valueRestrictions'] else 'None' valueRestrictions = requestField['valueRestrictions'] if requestField['valueRestrictions'] else 'None'
valueOptional = '?' if requestField['valueOptional'] else '' valueOptional = '?' if requestField['valueOptional'] else ''
valueOptionalBehavior = requestField['valueOptionalBehavior'] if requestField['valueOptional'] and requestField['valueOptionalBehavior'] else 'N/A' valueOptionalBehavior = requestField['valueOptionalBehavior'] if requestField['valueOptional'] and requestField['valueOptionalBehavior'] else 'N/A'
ret += '| {}{} | {} | {} | {} | {} |\n'.format(valueOptional, requestField['valueName'], requestField['valueType'], requestField['valueDescription'], valueRestrictions, valueOptionalBehavior) ret += '| {}{} | {} | {} | {} | {} |\n'.format(valueOptional, requestField['valueName'], valueType, requestField['valueDescription'], valueRestrictions, valueOptionalBehavior)
if request['responseFields']: if request['responseFields']:
ret += responseFieldHeader ret += responseFieldHeader
for responseField in request['responseFields']: for responseField in request['responseFields']:
ret += '| {} | {} | {} |\n'.format(responseField['valueName'], responseField['valueType'], responseField['valueDescription']) valueType = responseField['valueType'].replace('<', "&lt;").replace('>', "&gt;")
ret += '| {} | {} | {} |\n'.format(responseField['valueName'], valueType, responseField['valueDescription'])
if request != requestsOut[-1]: if request != requestsOut[-1]:
ret += '\n---\n\n' ret += '\n---\n\n'
@ -239,7 +241,8 @@ def get_events(events):
if event['dataFields']: if event['dataFields']:
ret += dataFieldHeader ret += dataFieldHeader
for dataField in event['dataFields']: for dataField in event['dataFields']:
ret += '| {} | {} | {} |\n'.format(dataField['valueName'], dataField['valueType'], dataField['valueDescription']) valueType = dataField['valueType'].replace('<', "&lt;").replace('>', "&gt;")
ret += '| {} | {} | {} |\n'.format(dataField['valueName'], valueType, dataField['valueDescription'])
if event != eventsOut[-1]: if event != eventsOut[-1]:
ret += '\n---\n\n' ret += '\n---\n\n'