openedx / openedx/code-annotations
Remove ability to comment between annotations
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 5
- 派生
- 13
- 平均合并
- 18 小时 26 分钟
- 30 天内合并 PR
- 4
描述
It has been discussed during toggles annotation work that the ability to intermix comments between code annotations doesn't seem to add much value, and instead adds implementation complexity and bugs.
See example test file for this use case:
https://github.com/openedx/code-annotations/blob/master/tests/extensions/python_test_files/multiline_singlelinecomment.pyt
See toggle annotation PR comment about potential issue with linting due to this issue: https://github.com/openedx/edx-platform/pull/27222#discussion_r606037209.
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
从 tests/extensions/python_test_files/multiline_singlelinecomment.pyt 开始，该文件展示了插入在注解之间的注释，然后跟踪该 fixture 所执行的实现。移除对这种排列方式的支持，更新相关预期，并验证注解解析和 linting 不再接受代码注解之间的注释。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- tooling
- Issue 类型
- 重构
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100