File: ext_napoleon_pep526_data_numpy.py

package info (click to toggle)
sphinx 4.5.0-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 22,656 kB
  • sloc: python: 74,641; javascript: 14,242; perl: 420; makefile: 247; sh: 57; xml: 19; ansic: 1
file content (20 lines) | stat: -rw-r--r-- 385 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
"""Test module for napoleon PEP 526 compatibility with numpy style"""

module_level_var: int = 99
"""This is an example module level variable"""


class PEP526NumpyClass:
    """
    Sample class with PEP 526 annotations and numpy docstring

    Attributes
    ----------
    attr1:
        Attr1 description

    attr2:
        Attr2 description
    """
    attr1: int
    attr2: str