Various improvements to doc_status.py

- Make comments opt-in (smaller table in width)
- Reduce length of Brief Description and Description (also smaller table as output)
- Make names cyan (blue is too dark on black terminal)
- Drop some redundant synonyms for the flags

(cherry picked from commit 034d6e811f)
This commit is contained in:
Rémi Verschelde 2016-04-26 21:35:06 +02:00
parent 6efe8818a7
commit 11aa0d1405
1 changed files with 10 additions and 10 deletions

View File

@ -14,6 +14,7 @@ flags = {
'c': platform.platform() != 'Windows', # Disable by default on windows, since we use ANSI escape codes 'c': platform.platform() != 'Windows', # Disable by default on windows, since we use ANSI escape codes
'b': False, 'b': False,
'g': False, 'g': False,
's': False,
'u': False, 'u': False,
'h': False, 'h': False,
'p': False, 'p': False,
@ -24,6 +25,7 @@ flag_descriptions = {
'c': 'Toggle colors when outputting.', 'c': 'Toggle colors when outputting.',
'b': 'Toggle showing only not fully described classes.', 'b': 'Toggle showing only not fully described classes.',
'g': 'Toggle showing only completed classes.', 'g': 'Toggle showing only completed classes.',
's': 'Toggle showing comments about the status.',
'u': 'Toggle URLs to docs.', 'u': 'Toggle URLs to docs.',
'h': 'Show help and exit.', 'h': 'Show help and exit.',
'p': 'Toggle showing percentage as well as counts.', 'p': 'Toggle showing percentage as well as counts.',
@ -32,7 +34,6 @@ flag_descriptions = {
} }
long_flags = { long_flags = {
'colors': 'c', 'colors': 'c',
'color': 'c',
'use-colors': 'c', 'use-colors': 'c',
'bad': 'b', 'bad': 'b',
@ -41,29 +42,27 @@ long_flags = {
'good': 'g', 'good': 'g',
'only-good': 'g', 'only-good': 'g',
'comments': 's',
'status': 's',
'urls': 'u', 'urls': 'u',
'url': 'u',
'generate-urls': 'u',
'gen-url': 'u', 'gen-url': 'u',
'help': 'h', 'help': 'h',
'percent': 'p', 'percent': 'p',
'percentages': 'p',
'use-percentages': 'p', 'use-percentages': 'p',
'overall': 'o', 'overall': 'o',
'use-overall': 'o', 'use-overall': 'o',
'items': 'i', 'items': 'i',
'collapse-items': 'i',
'collapse': 'i', 'collapse': 'i',
'narrow': 'i',
} }
table_columns = ['name', 'brief_description', 'description', 'methods', 'constants', 'members', 'signals'] table_columns = ['name', 'brief_description', 'description', 'methods', 'constants', 'members', 'signals']
table_column_names = ['Name', 'Brief Description', 'Description', 'Methods', 'Constants', 'Members', 'Signals'] table_column_names = ['Name', 'Brief Desc.', 'Desc.', 'Methods', 'Constants', 'Members', 'Signals']
colors = { colors = {
'name': [34], # blue 'name': [36], # cyan
'part_big_problem': [4, 31], # underline, red 'part_big_problem': [4, 31], # underline, red
'part_problem': [31], # red 'part_problem': [31], # red
'part_mostly_good': [33], # yellow 'part_mostly_good': [33], # yellow
@ -201,11 +200,12 @@ class ClassStatus:
if self.name.startswith('Total'): if self.name.startswith('Total'):
output['url'] = color('url', 'http://docs.godotengine.org/en/latest/classes/_classes.html') output['url'] = color('url', 'http://docs.godotengine.org/en/latest/classes/_classes.html')
if flags['s']:
output['comment'] = color('part_good', 'ALL OK') output['comment'] = color('part_good', 'ALL OK')
else: else:
output['url'] = color('url', 'http://docs.godotengine.org/en/latest/classes/class_{name}.html'.format(name=self.name.lower())) output['url'] = color('url', 'http://docs.godotengine.org/en/latest/classes/class_{name}.html'.format(name=self.name.lower()))
if not flags['g'] and self.is_ok(): if flags['s'] and not flags['g'] and self.is_ok():
output['comment'] = color('part_good', 'ALL OK') output['comment'] = color('part_good', 'ALL OK')
return output return output