-
First Check
Example Codefrom annotated_doc import Doc
def hi(
name: Annotated[
str,
Doc(
"Who to say hi to",
tldr="doc.tld.hi.tldr",
example="doc.example.example",
online_example="https://doc.example.example",
),
],
) -> None:
print(f"Hi, {name}!")Descriptioni am thinking about a feature, maybe not the first one but a lazy load of example files or tldr or test files like having a point to that file or a link with no need for source code directly import but i think it is not the best way to handle it with string import path b.c files can change and break everything may be a validation along to it and then it will help easy navigation and learning in place Operating SystemLinux Operating System DetailsNo response Version0 Python Version3.12 Additional ContextNo response |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 7 replies
-
|
Why not just specify URL inside the docstring? For example Markdown or reStructuredText variable: Annotated[
str,
Doc(
"`The link <https://github.com/kuyugama/theproject>`_"
)
] |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the interest! But this would be out of the scope of this project, so I'll pass on this. |
Beta Was this translation helpful? Give feedback.
Thanks for the interest! But this would be out of the scope of this project, so I'll pass on this.