File: ext_napoleon_pep526_data_numpy.py

package info (click to toggle)
sphinx 8.2.3-11
  • links: PTS, VCS
  • area: main
  • in suites: experimental, forky, sid
  • size: 26,936 kB
  • sloc: python: 105,864; javascript: 6,474; perl: 449; makefile: 178; sh: 37; xml: 19; ansic: 2
file content (22 lines) | stat: -rw-r--r-- 417 bytes parent folder | download | duplicates (8) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
"""Test module for napoleon PEP 526 compatibility with numpy style"""

from __future__ import annotations

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