10. Supplementary tests

In this chapter we test the following:

  • Method documentation boxes as referentiable objects

  • Constants in module documentation boxes as referentiable objects

  • Constants in classes inside classes as referentiable objects

  • Variables in classes as referentiable objects

  • Classes inside the modul as referentiable objects

Preamble

normative sections

  • Contract, Public classes, Public functions, Public constants

Contract

general

Public classes

A, B, X, Y

Public functions

<empty>

Public constants

CONSTANT_1

An important constant

CONSTANT_2

Another important constant

Module

doc_method_resolution

Waterloo module context

Classes and functions below this point implicitly belong to package/module doc_method_resolution.

Preamble

normative sections

  • Contract, Public variables, Public methods

Contract

general

constructor

Public variables

v

A variable

Public methods

m

Method overview

m

A method

Class

X –⁠ from doc_method_resolution

Public Methods in class X

Signature

doc_method_resolution.X.m(
) -> None

Preamble

normative sections

  • Contract, Parameters, Returns, Raises

Contract

general

Parameters

<empty>

Returns

Raises

<empty>

See also

Y.m, Y.v, CONSTANT_1, CONSTANT_2

Method

X.m –⁠ from doc_method_resolution

Preamble

normative sections

  • Contract, Public variables, Public methods

Contract

general

constructor

Public variables

v

A variable

Public methods

m

Method overview

m

A method

Class

Y –⁠ from doc_method_resolution

Public Methods in class Y

Signature

doc_method_resolution.Y.m(
) -> None

Preamble

normative sections

  • Contract, Parameters, Returns, Raises

Contract

general

Parameters

<empty>

Returns

Raises

<empty>

See also

X.m, X.v, CONSTANT_1, CONSTANT_2

Method

Y.m –⁠ from doc_method_resolution

Preamble

normative sections

  • Contract, Public types

Contract

general

constructor

Public types

INSIDE_Y_TYPE_1

Type Alias for List[int]

An important type

INSIDE_Y_TYPE_2

Type Alias for Dict[str, float]

Another important type

Class

Y.INSIDE_Y –⁠ from doc_method_resolution

Waterloo module context

Default module qualifier doc_method_resolution ends here. New default: doc_errors.

Preamble

normative sections

  • Contract, Public variables, Public methods

Contract

general

constructor

Public variables

v

A variable

Public methods

m

Method overview

m

A method

Class

A –⁠ from doc_method_resolution

Signature

doc_method_resolution.A.m(
) -> None

Preamble

normative sections

  • Contract, Parameters, Returns, Raises

Contract

general

Parameters

<empty>

Returns

Raises

<empty>

See also

B.m, B.v, Y.INSIDE_Y.INSIDE_Y_TYPE_1, Y.INSIDE_Y.INSIDE_Y_TYPE_2

Method

A.m –⁠ from doc_method_resolution

Preamble

normative sections

  • Contract, Public constants

Contract

general

constructor

Public constants

INSIDE_A_CONSTANT_1

An important constant

INSIDE_A_CONSTANT_2

Another important constant

Class

A.INSIDE_A –⁠ from doc_method_resolution

Preamble

normative sections

  • Contract, Public variables, Public methods

Contract

general

constructor

Public variables

v

A variable

Public methods

m

Method overview

m

A method

Class

B –⁠ from doc_method_resolution

Signature

doc_method_resolution.B.m(
) -> None

Preamble

normative sections

  • Contract, Parameters, Returns, Raises

Contract

general

Parameters

<empty>

Returns

Raises

<empty>

See also

A.m, A.v, A.INSIDE_A.INSIDE_A_CONSTANT_1, A.INSIDE_A.INSIDE_A_CONSTANT_2

Method

B.m –⁠ from doc_method_resolution