File: flavors_numpy.txt

package info (click to toggle)
python-pdoc 15.0.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,192 kB
  • sloc: python: 8,013; javascript: 1,156; makefile: 18; sh: 3
file content (29 lines) | stat: -rw-r--r-- 1,629 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<module flavors_numpy  # Example NumPy-style …
    <var module_level_variable1 = 12345>
    <var module_level_variable2 = 98765  # int: Module level va…>
    <function def function_with_types_in_docstring(param1, param2): ...  # Example function wit…>
    <function def function_with_pep484_type_annotations(param1: int, param2: str) -> bool: ...  # Example function wit…>
    <function def module_level_function(param1, param2=None, *args, **kwargs): ...  # This is an example o…>
    <function def example_generator(n): ...  # Generators have a ``…>
    <class flavors_numpy.ExampleError  # Exceptions are docum…
        <method def __init__(self, msg, code): ...>
        <var msg>
        <var code>
        <method def add_note(self, note: str): ...  # This method is prese…>
        <method def with_traceback(self, object, /): ...  # This method has a ch…>
        <var args  # inherited from builtins.BaseException.args>
    >
    <class flavors_numpy.ExampleClass  # The summary line for…
        <method def __init__(self, param1, param2, param3): ...  # Example of docstring…>
        <var attr1>
        <var attr2>
        <var attr3>
        <var attr4>
        <var attr5  # str: Docstring *afte…>
        <var readonly_property  # str: Properties shou…>
        <var readwrite_property  # :obj:`list` of :obj:…>
        <method def example_method(self, param1, param2): ...  # Class methods are si…>
    >
    <function def foo(var1, var2, *args, long_var_name='hi', **kwargs): ...  # Summarize the functi…>
    <function def invalid_format(test): ...  # In this example, the…>
>