Shorten article titles for ToC.

kaycebasques · kaycebasques · commit c1bfe1d0e361 · 2014-10-15T19:27:46.000-07:00
diff --git a/docs/correctness/index.rst b/docs/correctness/index.rst
@@ -6,54 +6,54 @@
 
     access_to_a_protected_member
     an_attribute_hides_this_method
-    arguments_number_differs_from_method
-    assigning_to_function_call_which_does_not_return
-    assigning_to_function_call_which_only_returns_none
+    Args number differs <arguments_number_differs_from_method>
+    Function doesn't return <assigning_to_function_call_which_does_not_return>
+    Function only returns None <assigning_to_function_call_which_only_returns_none>
     bad_except_clauses_order
-    bad_first_argument_given_to_super
+    Bad arg for super <bad_first_argument_given_to_super>
     class_has_no_init_method
     class_has_no_member
-    dangerous_default_value_as_argument
-    do_not_assign_a_lambda_expression
-    duplicate_argument_name_in_function_definition
-    else_clause_on_loop_without_a_break_statement
+    Dangerous default arg value <dangerous_default_value_as_argument>
+    Do not assign a lambda <do_not_assign_a_lambda_expression>
+    Duplicate arg names <duplicate_argument_name_in_function_definition>
+    No break statement <else_clause_on_loop_without_a_break_statement>
     exit_must_accept_three_arguments
     explicit_return_in_init
-    function_keyword_outside_of_function
-    future_import_is_not_the_first_statement
-    implementing_java-style_getters_and_setters
-    indentation_contains_mixed_spaces_and_tabs
+    Invalid function keyword <function_keyword_outside_of_function>
+    Future import must be first <future_import_is_not_the_first_statement>
+    Using Java style <implementing_java-style_getters_and_setters>
+    Spaces and tabs in indents <indentation_contains_mixed_spaces_and_tabs>
     indentation_contains_tabs
-    init_method_from_a_non-direct_base_class_is_called
-    init_method_from_base_class_not_called
+    Invalid init method <init_method_from_a_non-direct_base_class_is_called>
+    init not called <init_method_from_base_class_not_called>
     init_method_is_a_generator
     invalid_object_in_all
     iter_returns_non-iterator
-    list_comprehension_redefines_name_from_line_n
-    local_variable_name_referenced_before_assignment
+    List comprehension renaming <list_comprehension_redefines_name_from_line_n>
+    Using unassigned name <local_variable_name_referenced_before_assignment>
     method_could_be_a_function
     method_has_no_argument
-    method_is_abstract_in_class_but_is_not_overridden
+    Abstract method not overridden <method_is_abstract_in_class_but_is_not_overridden>
     missing_argument_to_super
     no_exception_type_specified
     no_name_in_module
-    no_value_passed_for_parameter_in_function_call
+    Missing parameter value <no_value_passed_for_parameter_in_function_call>
     not_using_defaultdict
     not_using_else_in_a_loop
     not_using_explicit_unpacking
-    not_using_get_to_return_a_default_value_from_a_dictionary
-    not_using_setdefault_to_initialize_a_dictionary
+    Returning default dict values <not_using_get_to_return_a_default_value_from_a_dictionary>
+    Initializing dicts <not_using_setdefault_to_initialize_a_dictionary>
     notimplemented_raised
     object_is_not_callable
-    parameter_passed_as_both_positional_and_keyword_argument
-    passing_unexpected_keyword_argument_in_function_call
-    raising_or_catching_a_class_which_does_not_inherit_from_baseexception
+    Arg is both positional and keyword <parameter_passed_as_both_positional_and_keyword_argument>
+    Unexpected keyword arg <passing_unexpected_keyword_argument_in_function_call>
+    Invalid exception class <raising_or_catching_a_class_which_does_not_inherit_from_baseexception>
     raising_unallowed_type
     redefining_name_from_outer_scope
-    return_with_argument_inside_generator
-    too_many_positional_arguments_for_function_call
+    Non-empty return in generator <return_with_argument_inside_generator>
+    Too many positional args <too_many_positional_arguments_for_function_call>
     undefined_name
     unreachable_code
     unused_argument
-    using_string_concatenation_instead_of_formatting
+    Using string concatenation <using_string_concatenation_instead_of_formatting>
 
diff --git a/docs/maintainability/index.rst b/docs/maintainability/index.rst
@@ -11,22 +11,22 @@ Use the following patterns to increase maintainability and avoid creating `spagh
 
     duplicate_key_in_dictionary
     from_module_import_all_used
-    import_module_shadowed_by_loop_variable
-    local_variable_name_is_assigned_to_but_never_used
+    Loop var shadows import <import_module_shadowed_by_loop_variable>
+    Name assigned but never used <local_variable_name_is_assigned_to_but_never_used>
     module_imported_but_not_used
-    not_enough_arguments_for_format_string
+    Not enough format string args <not_enough_arguments_for_format_string>
     not_using_with_to_open_files
     redefining_built-in
     redefinition_of_unused_name
-    returning_more_than_one_variable_type_from_function_call
+    Multiple function return types <returning_more_than_one_variable_type_from_function_call>
     single_responsibility_principle
     the_loop_may_never_terminate
-    too_many_arguments_for_format_string
+    Too many format string args <too_many_arguments_for_format_string>
     undefined_name_in_all
     unused_import
-    unused_import_from_wildcard_import
+    Unused wildcard import <unused_import_from_wildcard_import>
     unused_variable
-    using_possible_undefined_loop_variable
+    Possible undefined loop var <using_possible_undefined_loop_variable>
     using_the_global_statement
     very_complex_function
     wildcard_import
diff --git a/docs/performance/index.rst b/docs/performance/index.rst
@@ -7,5 +7,5 @@ Use the following patterns to reduce overhead and make your code more performant
 .. toctree::
     :maxdepth: 1
 
-    using_key_in_list_to_check_if_key_is_contained_in_a_list
+    Searching lists <using_key_in_list_to_check_if_key_is_contained_in_a_list>
 
diff --git a/docs/readability/index.rst b/docs/readability/index.rst
@@ -4,23 +4,23 @@
 .. toctree::
     :maxdepth: 1
 
-    asking_for_permission_instead_of_forgiveness_when_working_with_files
+    Asking for permission <asking_for_permission_instead_of_forgiveness_when_working_with_files>
     comparison_to_none
     comparison_to_true
-    do_not_compare_types_use_isinstance
+    Use isinstance <do_not_compare_types_use_isinstance>
     incomplete_docstring
     invalid_name
     lambda_may_not_be_necessary
     not_using_a_dict_comprehension
-    not_using_items_to_iterate_over_a_dictionary
-    not_using_named_tuples_when_returning_more_than_one_value
-    not_using_unpacking_for_updating_multiple_values_at_once
-    not_using_zip_to_iterate_over_a_pair_of_lists
-    putting_type_information_in_a_variable_name
-    test_for_membership_should_be_not_in
-    test_for_object_identity_should_be_is_not
+    Iterating over a dict <not_using_items_to_iterate_over_a_dictionary>
+    Returning named tuples <not_using_named_tuples_when_returning_more_than_one_value>
+    Unpacking <not_using_unpacking_for_updating_multiple_values_at_once>
+    Iterating over list pairs <not_using_zip_to_iterate_over_a_pair_of_lists>
+    Type information in names <putting_type_information_in_a_variable_name>
+    Testing for membership <test_for_membership_should_be_not_in>
+    Testing for identity <test_for_object_identity_should_be_is_not>
     unnecessary_parens_after_keyword
     unnecessary_pass_statement
     use_new_raise_syntax
     using_an_unpythonic_loop
-    using_map_or_filter_where_list_comprehension_is_possible
+    Unnecessary map/filter <using_map_or_filter_where_list_comprehension_is_possible>
