Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Feature Request: Rule metadata

未关闭
#208 4 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清
技术栈
python
领域
data

调研方向

首先定位 @dy.rule 入口点和 Rule 类,然后以现有的 column-metadata 行为作为参考。确定应如何以编程方式公开规则元数据或规则 docstring;当调用方可以通过所选 API 获取规则描述时,即表示完成。

由索引模型根据 Issue 内容生成。

描述

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).

主要语言
Python
星标
618
派生
21
平均合并
14 小时 34 分钟
30 天内合并 PR
7

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Quantco/dataframely 的其他 Issue

查看 Quantco/dataframely 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。