Skip to content

Add documentation entries for type aliases #485

Add documentation entries for type aliases

Add documentation entries for type aliases #485

GitHub Actions / Test report - 3.10 failed May 6, 2024 in 0s

Test report - 3.10 ❌

Tests failed

❌ test-results.xml

156 tests were completed in 36s with 153 passed, 1 failed and 2 skipped.

Test suite Passed Failed Skipped Time
pytest 153✔️ 1❌ 2✖️ 36s

❌ pytest

tests.test_build_js.test_build_js.Tests
  ✔️ test_autofunction_minimal
  ✔️ test_autofunction_explicit
  ✔️ test_autofunction_short
  ✔️ test_autofunction_long
  ✔️ test_autofunction_typedef
  ✔️ test_autofunction_callback
  ✔️ test_autofunction_example
  ✔️ test_autofunction_destructured_params
  ✔️ test_autofunction_defaults_in_doclet
  ✔️ test_autofunction_defaults_in_code
  ✔️ test_autofunction_variadic
  ✔️ test_autofunction_deprecated
  ✔️ test_autofunction_see
  ✔️ test_autofunction_static
  ✔️ test_autoclass
  ✔️ test_autoclass_members
  ✔️ test_autoclass_members_list
  ✔️ test_autoclass_members_list_star
  ✔️ test_autoclass_alphabetical
  ✔️ test_autoclass_private_members
  ✔️ test_autoclass_exclude_members
  ✔️ test_autoclass_example
  ✔️ test_autoclass_deprecated
  ✔️ test_autoclass_see
  ✔️ test_autoattribute
  ✔️ test_autoattribute_example
  ✔️ test_autoattribute_deprecated
  ✔️ test_autoattribute_see
  ✔️ test_getter_setter
  ✔️ test_no_shadowing
  ✔️ test_restructuredtext_injection
  ✔️ test_union_types
  ✔️ test_field_list_unwrapping
tests.test_build_ts.test_build_ts.TestTextBuilder
  ✔️ test_autoclass_constructor
  ✔️ test_autoclass_order
  ✔️ test_autoclass_star_order
  ✔️ test_abstract_extends_and_implements
  ✔️ test_exported_from
  ✔️ test_constructorless_class
  ✔️ test_optional_members
  ✔️ test_deprecated
  ✔️ test_example
  ✔️ test_async
  ✔️ test_symbol
  ✔️ test_predicate
  ✔️ test_get_set
  ✔️ test_inherited_docs
  ❌ test_automodule
	self = <test_build_ts.TestTextBuilder object at 0x7f80fc9b3730>
tests.test_build_ts.test_build_ts.TestHtmlBuilder
  ✔️ test_extends_links
  ✔️ test_implements_links
  ✔️ test_extends_type_param_links
  ✔️ test_xrefs
  ✔️ test_sphinx_link_in_description
  ✔️ test_sphinx_js_type_class
  ✔️ test_autosummary
tests.test_common_mark.test_common_mark.Tests
  ✔️ test_build_success
tests.test_dot_dot_paths.test_dot_dot_paths.Tests
  ✔️ test_dot_dot
tests.test_incremental
  ✔️ test_incremental_js
  ✖️ test_incremental_ts
tests.test_init
  ✔️ test_relative_path_root
tests.test_ir
  ✔️ test_default
  ✔️ test_missing_default
  ✔️ test_ir_serialization[x0]
  ✔️ test_ir_serialization[x1]
  ✔️ test_ir_serialization[x2]
  ✔️ test_ir_serialization[x3]
  ✔️ test_ir_serialization[x4]
  ✔️ test_ir_serialization[x5]
  ✔️ test_ir_serialization[x6]
  ✔️ test_ir_serialization[x7]
  ✔️ test_ir_serialization[x8]
tests.test_jsdoc_analysis.test_jsdoc
  ✔️ test_doclet_full_path
tests.test_jsdoc_analysis.test_jsdoc.TestFunction
  ✔️ test_top_level_and_function
tests.test_jsdoc_analysis.test_jsdoc.TestClass
  ✔️ test_class
tests.test_parsers
  ✔️ test_escapes
  ✔️ test_relative_dirs
tests.test_paths
  ✔️ test_global
  ✔️ test_node_modules1
  ✔️ test_node_modules2
  ✔️ test_env1
  ✔️ test_env2
  ✔️ test_err
  ✔️ test_global_install
tests.test_renderers
  ✔️ test_render_description
  ✔️ test_func_render_simple
  ✔️ test_func_render_shortnames
  ✔️ test_func_render_flags
  ✔️ test_func_render_description
  ✔️ test_func_render_params
  ✔️ test_func_render_returns
  ✔️ test_func_render_type_params
  ✔️ test_render_xref
  ✔️ test_func_render_param_type
  ✔️ test_func_render_param_options
  ✔️ test_func_render_param_exceptions
  ✔️ test_func_render_callouts
  ✔️ test_all
  ✔️ test_examples
  ✔️ test_type_alias
tests.test_suffix_tree
  ✔️ test_things
  ✔️ test_full_path
  ✔️ test_terminal_insertion
  ✔️ test_ambiguous_even_if_full_path
  ✔️ test_ambiguous_paths_reported
  ✔️ test_value_ambiguity
tests.test_testing
  ✔️ test_dict_where
tests.test_typedoc_analysis.test_typedoc_analysis.TestPathSegments
  ✔️ test_class
  ✔️ test_instance_property
  ✔️ test_static_property
  ✔️ test_interface_property
  ✔️ test_weird_name
  ✔️ test_getter
  ✔️ test_setter
  ✔️ test_method
  ✔️ test_static_method
  ✔️ test_constructor
  ✔️ test_function
  ✖️ test_relative_paths
  ✔️ test_namespaced_var
tests.test_typedoc_analysis.test_typedoc_analysis.TestConvertNode
  ✔️ test_class1
  ✔️ test_interface
  ✔️ test_interface_function_member
  ✔️ test_variable
  ✔️ test_function
  ✔️ test_constructor
  ✔️ test_properties
  ✔️ test_getter
  ✔️ test_setter
  ✔️ test_type_alias
tests.test_typedoc_analysis.test_typedoc_analysis.TestTypeName
  ✔️ test_basic
  ✔️ test_named_interface
  ✔️ test_interface_readonly_member
  ✔️ test_array
  ✔️ test_literal_types
  ✔️ test_unions
  ✔️ test_intersection
  ✔️ test_generic_function
  ✔️ test_generic_member
  ✔️ test_constrained_by_interface
  ✔️ test_constrained_by_key
  ✔️ test_class_constrained
  ✔️ test_constrained_by_constructor
  ✔️ test_utility_types
  ✔️ test_internal_symbol_reference
  ✔️ test_constrained_by_property
  ✔️ test_optional_property
  ✔️ test_code_in_description
  ✔️ test_destructured
  ✔️ test_funcarg
  ✔️ test_namedtuplearg
  ✔️ test_query
  ✔️ test_type_operator
  ✔️ test_private_type_alias1
  ✔️ test_private_type_alias2
  ✔️ test_hidden_type_top_level
  ✔️ test_hidden_type_member

Annotations

Check failure on line 0 in test-results.xml

See this annotation in the file changed.

@github-actions github-actions / Test report - 3.10

pytest ► tests.test_build_ts.test_build_ts.TestTextBuilder ► test_automodule

Failed test found in:
  test-results.xml
Error:
  self = <test_build_ts.TestTextBuilder object at 0x7f80fc9b3730>
Raw output
self = <test_build_ts.TestTextBuilder object at 0x7f80fc9b3730>

        def test_automodule(self):
>           self._file_contents_eq(
                "automodule",
                dedent(
                    """\
    module.a
    
       type: 7
    
       The thing.
    
    module.aInstance
    
       type: "A"
    
       An instance of class A
    
    module.interfaceInstance
    
       type: "I"
    
       An instance of the interface
    
    module.q
    
       type: { a: string; b: number; }
    
       Another thing.
    
    module.t
    
       type: "TestTypeAlias"<"A">
    
    module.t2
    
       type: "TestTypeAlias2"
    
    module.zInstance
    
       type: "Z"<"A">
    
    async module.f()
    
       Clutches the bundle
    
       Returns:
          Promise<void>
    
    module.functionWithTypeParam<T>(z)
    
       A function with a type parameter!
    
       We'll refer to ourselves: "functionWithTypeParam()"
    
       Type parameters:
          **T** -- The type parameter (extends "A")
    
       Arguments:
          * **z** ("Z"<T>) -- A Z of T
    
       Returns:
          T -- The x field of z
    
    module.z(a, b)
    
       Arguments:
          * **a** (number)
    
          * **b** ({ a: string; b: number; })
    
       Returns:
          number
    
    class module.A()
    
       This is a summary. This is more info.
    
       *exported from* "module"
    
       A.[Symbol․iterator]()
    
       async A.f()
    
          Returns:
             Promise<void>
    
       A.g(a)
    
          Arguments:
             * **a** (number)
    
          Returns:
             number
    
    class module.Z<T>(a, b)
    
       *exported from* "module"
    
       Type parameters:
          **T** -- Description of T (extends "A")
    
       Arguments:
          * **a** (number)
    
          * **b** (number)
    
       Z.x
    
          type: T
    
       Z.z()
    
    interface module.I
    
       Documentation for the interface I
    
       *exported from* "module"
    
    module.TestTypeAlias<T>
    
       type: { a: T; }
    
       A super special type alias
    
       Type parameters:
          **T** -- The whatsit (extends "A")
    
    module.TestTypeAlias2
    
       type: { a: number; }
                    """
                ),
            )
E           assert 'module.TestT...n\n   Z.z()\n' == 'module.a\n\n...: number; }\n'
E             
E             + module.TestTypeAlias<T>
E             + 
E             +    type: { a: T; }
E             + 
E             +    A super special type alias
E             + 
E             +    Type parameters:
E             +       **T** -- The whatsit (extends "A")
E             + 
E             + module.TestTypeAlias2
E             + 
E             +    type: { a: number; }
E             + 
E               module.a
E               
E                  type: 7
E               
E                  The thing.
E               
E               module.aInstance
E               
E                  type: "A"
E               
E                  An instance of class A
E               
E               module.interfaceInstance
E               
E                  type: "I"
E               
E                  An instance of the interface
E               
E               module.q
E               
E                  type: { a: string; b: number; }
E               
E                  Another thing.
E               
E               module.t
E               
E                  type: "TestTypeAlias"<"A">
E               
E               module.t2
E               
E                  type: "TestTypeAlias2"
E               
E               module.zInstance
E               
E                  type: "Z"<"A">
E               
E               async module.f()
E               
E                  Clutches the bundle
E               
E                  Returns:
E                     Promise<void>
E               
E               module.functionWithTypeParam<T>(z)
E               
E                  A function with a type parameter!
E               
E                  We'll refer to ourselves: "functionWithTypeParam()"
E               
E                  Type parameters:
E                     **T** -- The type parameter (extends "A")
E               
E                  Arguments:
E                     * **z** ("Z"<T>) -- A Z of T
E               
E                  Returns:
E                     T -- The x field of z
E               
E               module.z(a, b)
E               
E                  Arguments:
E                     * **a** (number)
E               
E                     * **b** ({ a: string; b: number; })
E               
E                  Returns:
E                     number
E               
E             + interface module.I
E             + 
E             +    Documentation for the interface I
E             + 
E             +    *exported from* "module"
E             + 
E               class module.A()
E               
E                  This is a summary. This is more info.
E               
E                  *exported from* "module"
E               
E                  A.[Symbol․iterator]()
E               
E                  async A.f()
E               
E                     Returns:
E                        Promise<void>
E               
E                  A.g(a)
E               
E                     Arguments:
E                        * **a** (number)
E               
E                     Returns:
E                        number
E               
E               class module.Z<T>(a, b)
E               
E                  *exported from* "module"
E               
E                  Type parameters:
E                     **T** -- Description of T (extends "A")
E               
E                  Arguments:
E                     * **a** (number)
E               
E                     * **b** (number)
E               
E                  Z.x
E               
E                     type: T
E               
E                  Z.z()
E             - 
E             - interface module.I
E             - 
E             -    Documentation for the interface I
E             - 
E             -    *exported from* "module"
E             - 
E             - module.TestTypeAlias<T>
E             - 
E             -    type: { a: T; }
E             - 
E             -    A super special type alias
E             - 
E             -    Type parameters:
E             -       **T** -- The whatsit (extends "A")
E             - 
E             - module.TestTypeAlias2
E             - 
E             -    type: { a: number; }

tests/test_build_ts/test_build_ts.py:248: AssertionError