Skip to content

Commit 77787b7

Browse files
committed
docs: Fix casing of deprecated
1 parent 98f3c2c commit 77787b7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/examples/enhanced.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# The goal is to replace the following sections:
66

7-
# Deprecated
7+
# deprecated
88
# Parameters
99
# Other Parameters
1010
# Raises
@@ -18,7 +18,7 @@
1818
from typing import (
1919
Annotated,
2020
Generator,
21-
Deprecated,
21+
deprecated,
2222
Doc,
2323
Name,
2424
Raises,
@@ -29,7 +29,7 @@
2929
# Documenting deprecations, replacing Deprecated sections:
3030
DEPRECATED: Annotated[
3131
int,
32-
Deprecated(
32+
deprecated(
3333
"""Deprecated since v2.
3434
3535
Please stop using this deprecated attribute, thanks!
@@ -40,12 +40,12 @@
4040

4141

4242
# For functions, maybe add the information to the return value annotation:
43-
def deprecated1() -> Annotated[None, Deprecated("Deprecated since v2.")]:
43+
def deprecated1() -> Annotated[None, deprecated("Deprecated since v2.")]:
4444
"""Showing off deprecated functions."""
4545

4646

4747
# For parameters:
48-
def deprecated2(param1: Annotated[int, Deprecated("Deprecated since v2."), Doc("Description of param1.")] = 0):
48+
def deprecated2(param1: Annotated[int, deprecated("Deprecated since v2."), Doc("Description of param1.")] = 0):
4949
"""Showing off deprecated parameters."""
5050

5151

0 commit comments

Comments
 (0)