search

heynemann / pyvows

Python implementation of Vows.js
http://pyvows.org
MIT License
133 stars 28 forks source link

Add missing docstrings #49

Closed Zearin closed 11 years ago

Zearin commented 11 years ago

Through an unholy combination of pylint and sed sorcery, I have created a list of everything in pyvows that needs a docstring:

async_topic.py

    16:VowsAsyncTopic    Missing docstring
    31:VowsAsyncTopicValue    Missing docstring

color.py

    18:NoColor    Missing docstring

console.py

    34:Messages    Missing docstring
    51:__get_arguments    Missing docstring
    89:run    Missing docstring
    104:main    Missing docstring

core.py

    24:locate    Missing docstring
    37:expect    Missing docstring
    55:expect.__getattr__.assert_topic    Missing docstring
    61:VowsAssertion    Missing docstring
    62:VowsAssertion.AssertionNotFoundError    Missing docstring
    73:VowsAssertionError    Missing docstring
    91:Vows    Missing docstring
    94:Vows.Context    Missing docstring
    102:Vows.Context._get_first_available_topic    Missing docstring
    120:Vows.Context.ignore    Missing docstring
    124:Vows.Context.setup    Missing docstring
    127:Vows.Context.teardown    Missing docstring
    130:Vows.NotErrorContext    Missing docstring
    131:Vows.NotErrorContext.should_not_be_an_error    Missing docstring
    134:Vows.NotEmptyContext    Missing docstring
    135:Vows.NotEmptyContext.should_not_be_empty    Missing docstring
    143:Vows.async_topic    Missing docstring
    144:Vows.async_topic.wrapper    Missing docstring
    151:Vows.asyncTopic    Missing docstring
    156:Vows.batch    Missing docstring
    157:Vows.batch.method_name    Missing docstring
    165:Vows.assertion    Missing docstring
    166:Vows.assertion.method_name    Missing docstring
    169:Vows.assertion.exec_assertion    Missing docstring
    176:Vows.create_assertions    Missing docstring
    179:Vows.create_assertions.exec_assertion    Missing docstring
    187:Vows.create_assertions.exec_not_assertion    Missing docstring
    198:Vows.create_assertions.wrapper    Missing docstring
    204:Vows.ensure    Missing docstring
    212:Vows.gather    Missing docstring

reporting.py

    33:ensure_encoded    Missing docstring
    40:VowsDefaultReporter    Missing docstring
    50:VowsDefaultReporter.camel_split    Missing docstring
    53:VowsDefaultReporter.under_split    Missing docstring
    56:VowsDefaultReporter.format_traceback    Missing docstring
    57:VowsDefaultReporter.format_traceback.indent    Missing docstring
    64:VowsDefaultReporter.get_uncovered_lines    Missing docstring
    82:VowsDefaultReporter.handle_success    Missing docstring
    86:VowsDefaultReporter.handle_error    Missing docstring
    92:VowsDefaultReporter.print_header    Missing docstring
    109:VowsDefaultReporter.indent_print    Missing docstring
    118:VowsDefaultReporter.humanized_print    Missing docstring
    125:VowsDefaultReporter.print_traceback    Missing docstring
    146:VowsDefaultReporter.pretty_print    Missing docstring
    174:VowsDefaultReporter.print_context    Missing docstring
    238:VowsDefaultReporter.print_profile    Missing docstring
    268:VowsDefaultReporter.parse_coverage_xml    Missing docstring
    286:VowsDefaultReporter.print_coverage    Missing docstring

result.py

    14:VowsResult    Missing docstring
    20:VowsResult.successful    Missing docstring
    24:VowsResult.total_test_count    Missing docstring
    28:VowsResult.successful_tests    Missing docstring
    32:VowsResult.errored_tests    Missing docstring
    35:VowsResult.count_tests    Missing docstring
    47:VowsResult.eval_context    Missing docstring
    57:VowsResult.get_topic_times    Missing docstring
    74:VowsResult.get_worst_topics    Missing docstring

runner.py

    28:VowsParallelRunner    Missing docstring
    36:VowsParallelRunner.run    Missing docstring
    49:VowsParallelRunner.run_context    Missing docstring
    52:VowsParallelRunner.async_run_context    Missing docstring
    86:VowsParallelRunner.async_run_context.run_with_topic    Missing docstring
    105:VowsParallelRunner.async_run_context.run_with_topic.iterate_members    Missing docstring
    132:VowsParallelRunner.async_run_context.handle_callback    Missing docstring
    142:VowsParallelRunner.run_vow    Missing docstring
    145:VowsParallelRunner.async_run_vow    Missing docstring
    184:VowsParallelRunner._get_code_for    Missing docstring
    192:VowsParallelRunner.file_info_for    Missing docstring
    200:VowsParallelRunner.get_topics_for    Missing docstring
    247:FunctionWrapper.wrap    Missing docstring
    251:FunctionWrapper.wrap.wrapper    Missing docstring

version.py

    16:to_str    Missing docstring

xunit.py

    19:XUnitReporter    Missing docstring
    24:XUnitReporter.write_report    Missing docstring
    29:XUnitReporter.to_xml    Missing docstring
    33:XUnitReporter.summarize_results    Missing docstring
    45:XUnitReporter.create_report_document    Missing docstring
    65:XUnitReporter.create_test_case_elements    Missing docstring

assertions.boolean.py

    17:to_be_true    Missing docstring
    22:to_be_false    Missing docstring

assertions.classes.py

    17:to_be_instance_of    Missing docstring
    22:not_to_be_instance_of    Missing docstring

assertions.emptiness.py

    17:to_be_empty    Missing docstring

assertions.equality.py

    17:to_equal    Missing docstring

assertions.errors.py

    19:to_be_an_error_like    Missing docstring
    24:to_have_an_error_message_of    Missing docstring
    29:to_be_an_error    Missing docstring

assertions.function.py

    19:to_be_a_function    Missing docstring
    24:not_to_be_a_function    Missing docstring

assertions.inclusion.py

    18:to_include    Missing docstring

assertions.length.py

    17:to_length    Missing docstring
    22:not_to_length    Missing docstring

assertions.like.py

    22:to_be_like    Missing docstring
    25:compare_alike    Missing docstring
    28:match_alike    Missing docstring
    42:compare_strings    Missing docstring
    47:compare_numbers    Missing docstring
    53:compare_dicts    Missing docstring
    56:match_dicts    Missing docstring
    62:compare_lists    Missing docstring
    65:match_lists    Missing docstring

assertions.nullable.py

    17:to_be_null    Missing docstring
    22:not_to_be_null    Missing docstring

assertions.numeric.py

    19:to_be_numeric    Missing docstring

assertions.regexp.py

    19:to_match    Missing docstring
    24:not_to_match    Missing docstring
Zearin commented 11 years ago

w00t!

I’m closing this issue, even though there are some docstrings still missing. But I’ll need help/explanation of what the code does to write them, which is why I couldn’t get them this time around. So, I’ll open another issue for them.