openedx / openedx/code-annotations
Ensure only defined annotations are allowed
未关闭
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 5
- 派生
- 13
- 平均合并
- 18 小时 26 分钟
- 30 天内合并 PR
- 4
描述
At this time, users are not given any linting warnings when undefined annotations are used, including misspellings.
Additional Notes:
- An example: someone might use
toggle_warningsinstead oftoggle_warning. - It has been noted that removing the ability to comment between annotations (see https://github.com/openedx/code-annotations/issues/89) would make this simpler to implement.
- Linting might be implemented here: https://github.com/openedx/edx-lint/blob/7573005f89df7f78142a2af86673206e8b43c4d5/edx_lint/pylint/annotations_check.py#L291
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 edx_lint/pylint/annotations_check.py 第 291 行附近开始,以了解现有的 linting 入口点。查看 issue #89 中关于注解之间注释的讨论,然后将完成定义为:当注解名称未定义或拼写错误时发出警告,例如使用 toggle_warnings 而不是 toggle_warning。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- tooling
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100