Coala: typed_list/dict/ordered_dict(...) annotations look ugly in API docs

Created on 7 Jun 2017  路  3Comments  路  Source: coala/coala

Let's take PEP8Bear.run() as example. sphinx autodoc creates the following confusing signature:

run(filename, file, max_line_length: int = 79, indent_size: int = 4, pep_ignore: <function typed_list.<locals>.<lambda> at 0x000001CC99B73378> = (), pep_select: <function typed_list.<locals>.<lambda> at 0x000001CC99B73400> = (), local_pep8_config: bool = False)

coalib.settings.Setting.typed_list/dict/ordered_dict() should better return converters with useful __repr__ instead of lambda functions

@sils @Makman2 @jayvdb

arecore aredocumentation difficultlow importancmedium

All 3 comments

Let's override their __repr__ then :+1: :)

In the end I think it should look like

typed_list(str)
typed_list(int)

etc.

@Makman2 Those were exactly my ideas :)

Was this page helpful?
0 / 5 - 0 ratings