Should we expose decorators at the package top-level?

aiidateam / aiida-workgraph

Efficiently design and manage flexible workflows with AiiDA, featuring an interactive GUI, checkpoints, provenance tracking, and remote execution capabilities.

https://aiida-workgraph.readthedocs.io/en/latest/

MIT License

10 stars 5 forks source link

Should we expose decorators at the package top-level? #354

Open GeigerJ2 opened 1 week ago

GeigerJ2 commented 1 week ago

Currently, we expose both task, as well as Task at the top-level API, with the first being the decorator and the second one the class:

https://github.com/aiidateam/aiida-workgraph/blob/2559c2111d1df1759638781c43d0ae95f7f37925/aiida_workgraph/__init__.py#L10-L14

I found this a bit confusing, personally.

EDIT: As noted by @superstar54, Task should not be exposed.