Feature Request: Rule metadata
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 618
- Forks
- 21
- Avg merge
- 14h 34m
- Merged PRs (30d)
- 7
Description
It'd be great if rules could be provided metadata, similarly to how columns can, to be able to pass for example a description of the rule that could be programmatically accessed from elsewhere.
i.e. @dy.rule(metadata={'description': 'xxx'})
Alternatively, allowing the rule's docstring to override the Rule class docstring could also work -- i.e. via one of the following solutions: https://stackoverflow.com/a/68733424 (which would allow one to do Schema.rule_func.__doc__ to get the docstring).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the @dy.rule entry point and the Rule class, then use the existing column-metadata behavior as a reference. Decide how rule metadata or a rule docstring should be exposed programmatically; done means callers can retrieve the rule description through the selected API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100