[manual/lua] added support for adding warning/note/tip's to function descriptions.
Dieser Commit ist enthalten in:
Ursprung
b80bfb8a22
Commit
dae2be5e88
@ -8,6 +8,7 @@ import json
|
||||
import operator
|
||||
import shutil
|
||||
import datetime
|
||||
import textwrap
|
||||
|
||||
|
||||
class LuaDoc:
|
||||
@ -625,6 +626,15 @@ class LuaDoc:
|
||||
|
||||
md += self._get_term(item_term_prefix + item['lua_name'].lower() + ':description') + os.linesep + os.linesep
|
||||
|
||||
for qualifier in ['warning', 'note', 'tip']:
|
||||
description = item_term_prefix + item['lua_name'].lower() + '.' + qualifier + ':description'
|
||||
if description in self._terms:
|
||||
md += '!!! ' + qualifier
|
||||
title = item_term_prefix + item['lua_name'].lower() + '.' + qualifier + ':title'
|
||||
if title in self._terms:
|
||||
md += ' "' + self._get_term(title) + '"'
|
||||
md += os.linesep + textwrap.indent(self._get_term(description), ' ' * 4) + os.linesep + os.linesep
|
||||
|
||||
if len(item['parameters']) > 0:
|
||||
md += '**' + self._get_term('parameters') + ':**' + os.linesep + os.linesep
|
||||
for param in item['parameters']:
|
||||
|
||||
Laden…
x
In neuem Issue referenzieren
Einen Benutzer sperren