LonamiWebs/Telethon
1
1
Fork 0
mirror of https://github.com/LonamiWebs/Telethon.git synced 2024-11-25 10:53:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Don't link generic arguments on the docs

Browse Source
This commit is contained in:
Lonami Exo 2017-04-08 12:41:31 +02:00
parent 64a1a69a5e
commit 356ed164f7
2 changed files with 23 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/docs_writer.py
View File

@ -107,6 +107,7 @@ class DocsWriter:
# Write all the arguments (or do nothing if there's none)
for arg in tlobject.args:
self.write(' ')
add_link = not arg.generic_definition and not arg.is_generic
# "Opening" modifiers
if arg.generic_definition:
@ -128,9 +129,11 @@ class DocsWriter:
# Argument type
if arg.type:
self.write('<a href="')
self.write(self.type_to_path(arg.type))
self.write('">%s</a>' % arg.type)
if add_link:
self.write('<a href="%s">' % self.type_to_path(arg.type))
self.write(arg.type)
if add_link:
self.write('</a>')
else:
self.write('#')
@ -142,9 +145,17 @@ class DocsWriter:
self.write('}')
# Now write the resulting type (result from a function, or type for a constructor)
self.write(' = <a href="')
self.write(self.type_to_path(tlobject.result))
self.write('">%s</a>' % tlobject.result)
self.write(' = ')
generic_name = next((arg.name for arg in tlobject.args
if arg.generic_definition), None)
if tlobject.result == generic_name:
# Generic results cannot have any link
self.write(tlobject.result)
else:
self.write('<a href="')
self.write(self.type_to_path(tlobject.result))
self.write('">%s</a>' % tlobject.result)
self.write('</pre>')

9
docs/generate.py
View File

@ -221,9 +221,12 @@ def generate_documentation(scheme_file):
bold=True)
# Type row
docs.add_row(arg.type,
link=get_path_for_type(arg.type, relative_to=filename),
align='center')
if arg.is_generic:
docs.add_row('!' + arg.type, align='center')
else:
docs.add_row(arg.type,
link=get_path_for_type(arg.type, relative_to=filename),
align='center')
# Create a description for this argument
description = ''