dlt-hub / dlt-hub/dlt

Make type hints for `@dlt.source` / `@dlt.resource` decorated functions more prominent in the documentation

Open
#4,091 2 comments 0 reactions 1 assignee Claimed by @zilto View on GitHub
documentation needs confirmation
Dominant language
Python
Stars
5.9k
Forks
600
Avg merge
1d 14h
Merged PRs (30d)
38

Description

### Documentation description

The correct type hints for a function decorated with `@dlt.source` or `@dlt.resource` are difficult to find in public facing docs. Finding a good example required a pretty deep dive into the code base.

I would expect a short section in the source docs, resource docs and cookbook example with a typed example, including import path and annotation.

This would help teams that adopt dlt and strict typing, prevent guesswork and quicken adoption.

### Are you a dlt user?

I'm considering using dlt, but the documentation is unclear.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.