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

Merge pull request #874 from dnaka91/fix-markdown-arrays

Browse Source 
docs: Fix `Array` type in markdown
This commit is contained in:
tt2468 2021-12-17 13:56:41 +07:00 committed by GitHub
commit 6f72da83ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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']:
ret += requestFieldHeader
for requestField in request['requestFields']:
valueType = requestField['valueType'].replace('<', "&lt;").replace('>', "&gt;")
valueRestrictions = requestField['valueRestrictions'] if requestField['valueRestrictions'] else 'None'
valueOptional = '?' if requestField['valueOptional'] else ''
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']:
ret += responseFieldHeader
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]:
ret += '\n---\n\n'
@ -239,7 +241,8 @@ def get_events(events):
if event['dataFields']:
ret += dataFieldHeader
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]:
ret += '\n---\n\n'