已开启
docs: improve OpenHarmony documentation accuracy #40
docs: improve OpenHarmony documentation accuracy #40
已开启
sunkaiyang创建于 3 天前
sunkaiyang
sunkaiyang
3 天前

docs: improve OpenHarmony documentation accuracy

likedislike
合并受阻
sunkaiyangsunkaiyang
3 天前 关联了issue:docs: improve OpenHarmony documentation accuracy
openharmony_ci
openharmony_ci成员
3 天前 评论:

感谢提交 Pull Requests!
Thanks for submitting a pull request.

likedislike
openharmony_ciopenharmony_ci成员
3 天前 添加了label:dco检查成功
sunkaiyang
sunkaiyang
3 天前 评论:

start build

likedislike
openharmony_ci
openharmony_ci成员
3 天前 评论:

首次触发
门禁构建开始,包含静态检查、代码编译【rntpc_br_rnoh0.72编译】,预计在60分钟内完成,门禁结果会同步发送到注册邮箱。您可以通过如下链接跟踪门禁进展:http://dcp.openharmony.cn/workbench/cicd/detail/6a9a8abb64650f998bbf041e/runlist

likedislike
openharmony_ciopenharmony_ci成员
3 天前 添加了label:静态检查失败
openharmony_ci
openharmony_ci成员
3 天前 评论:

代码门禁未通过
您可以通过如下链接查看门禁报告:http://dcp.openharmony.cn/workbench/cicd/detail/6a9a8abb64650f998bbf041e/runlist

静态检查:

# check type result report
1 codeCheck noPass >>>

编译测试:
# Device build result package
1 rntpc_br_rnoh0.72 pending NA

likedislike
cpf-manager
cpf-manager3 天前进行代码检视3
README.md
已过期
@@ -355,0 +329,4 @@
329+└─harmony
330+ └─view_shot # HarmonyOS 适配核心代码
331+ │ Index.ets # HAR 模块入口
332+ │ ts.ts # ArkTS 导出入口
cpf-manager
cpf-manager3 天前评论:

【AI-Review】【一般】【基础代码问题】【可读性问题】目录结构文档中 ts.ts 文件扩展名与实际不符

● 问题: README.md 第 332 行的目录结构文档中将 ArkTS 导出入口文件标注为 ts.ts,但通过 GitCode API 验证 PR head(SHA: 4369ae5d)实际仓库中的文件为 harmony/view_shot/ts.ets(文件大小 692 字节,扩展名为 .ets)。该文件的内容为 export * from './src/main/ets/ViewShotPackage' 等 ArkTS 导出语句。PR 修改前的 README 正确写为 ts.ets,本 PR 将其改为 ts.ts,引入了文档与实际文件名不一致的问题。

● 影响: 一般。开发者按照 README 目录结构查找 ts.ts 文件时将无法找到,造成导航困难;同时 PR 的标题为 "improve OpenHarmony documentation accuracy",此修改反而降低了文档准确性。

● 建议: 将第 332 行的 ts.ts 改回 ts.ets,与实际文件 harmony/view_shot/ts.ets 保持一致。

likedislike
System
系统消息系统
3 天前 评论:

changed this line on 55bd27e3 view diff detail

sunkaiyang
sunkaiyang
3 天前 评论:

已经修改

cpf-manager
cpf-manager3 天前进行代码检视3
README.md
已过期
@@ -355,0 +339,4 @@
339+ │ └─ ViewShotTurboModule.h
340+ └─ets # ArkTS 业务实现
341+ │ Logger.ts
342+ │ ViewShotPackage.ts
cpf-manager
cpf-manager3 天前评论:

【AI-Review】【一般】【基础代码问题】【可读性问题】目录结构文档中 ViewShotPackage.ts 文件扩展名与实际不符

● 问题: README.md 第 342 行的目录结构文档中将 ViewShotPackage 标注为 ViewShotPackage.ts,但通过 GitCode API 验证 PR head(SHA: 4369ae5d)实际仓库中的文件为 harmony/view_shot/src/main/ets/ViewShotPackage.ets(文件大小 1405 字节,扩展名为 .ets)。该文件定义了 ViewShotPackage 类。PR 修改前的 README 正确写为 ViewShotPackage.ets,本 PR 将其改为 ViewShotPackage.ts,引入了文档与实际文件名不一致的问题。注意:同目录下的 ViewShotTurboModule.ts(第 343 行)反而是正确的,本 PR 已将其从 .ets 修正为 .ts,但 ViewShotPackage 的修正方向相反。

● 影响: 一般。开发者按文档查找 ViewShotPackage.ts 将无法找到该文件,同时 ts.ets 中的 export * from './src/main/ets/ViewShotPackage' 导出语句也依赖 .ets 扩展名,文档与代码不一致会误导用户。

● 建议: 将第 342 行的 ViewShotPackage.ts 改回 ViewShotPackage.ets,与实际文件保持一致。

likedislike
System
系统消息系统
3 天前 评论:

changed this line on 55bd27e3 view diff detail

sunkaiyang
sunkaiyang
3 天前 评论:

已经修改

cpf-manager
cpf-manager3 天前进行代码检视3
README_en.md
已过期
@@ -357,0 +331,4 @@
331+└─harmony
332+ └─view_shot # HarmonyOS adaptation core code
333+ │ Index.ets # HAR module entry
334+ │ ts.ts # ArkTS export entry
cpf-manager
cpf-manager3 天前评论:

【AI-Review】【一般】【基础代码问题】【可读性问题】Directory structure doc lists ts.ts but actual file is ts.ets

● 问题: README_en.md line 334 lists the ArkTS export entry as ts.ts, but the actual file in the repository at PR head (SHA: 4369ae5d) is harmony/view_shot/ts.ets (verified via GitCode API, file size 692 bytes, extension .ets). The file contains ArkTS export statements like export * from './src/main/ets/ViewShotPackage'. The pre-PR README correctly listed it as ts.ets; this PR changed it to ts.ts, introducing an inconsistency between the documentation and the actual file name.

● 影响: General. Developers following the directory structure to locate ts.ts will not find the file. The PR title is "improve OpenHarmony documentation accuracy", but this change reduces accuracy.

● 建议: Change line 334 from ts.ts back to ts.ets to match the actual file harmony/view_shot/ts.ets.

likedislike
System
系统消息系统
3 天前 评论:

changed this line on 55bd27e3 view diff detail

sunkaiyang
sunkaiyang
3 天前 评论:

已经修改

cpf-manager
cpf-manager3 天前进行代码检视3
README_en.md
已过期
@@ -357,0 +341,4 @@
341+ │ └─ ViewShotTurboModule.h
342+ └─ets # ArkTS implementation
343+ │ Logger.ts
344+ │ ViewShotPackage.ts
cpf-manager
cpf-manager3 天前评论:

【AI-Review】【一般】【基础代码问题】【可读性问题】Directory structure doc lists ViewShotPackage.ts but actual file is ViewShotPackage.ets

● 问题: README_en.md line 344 lists ViewShotPackage as ViewShotPackage.ts, but the actual file in the repository at PR head (SHA: 4369ae5d) is harmony/view_shot/src/main/ets/ViewShotPackage.ets (verified via GitCode API, file size 1405 bytes, extension .ets). This file defines the ViewShotPackage class. The pre-PR README correctly listed it as ViewShotPackage.ets; this PR changed it to ViewShotPackage.ts, introducing an inconsistency. Note that the sibling file ViewShotTurboModule.ts on line 345 is correct (the PR fixed it from .ets to .ts), but ViewShotPackage was changed in the wrong direction.

● 影响: General. Developers following the documentation to locate ViewShotPackage.ts will not find the file. Additionally, the ts.ets export statement export * from './src/main/ets/ViewShotPackage' depends on the .ets extension, so the documentation misleads users.

● 建议: Change line 344 from ViewShotPackage.ts back to ViewShotPackage.ets to match the actual file.

likedislike
System
系统消息系统
3 天前 评论:

changed this line on 55bd27e3 view diff detail

sunkaiyang
sunkaiyang
3 天前 评论:

已经修改

sunkaiyangsunkaiyang
3 天前 强制推送  1 个提交:55bd27e3-docs: improve OpenHarmony documentation accuracy
openharmony_ciopenharmony_ci成员
3 天前 删除了label:静态检查失败
openharmony_ci
openharmony_ci成员
3 天前 评论:

代码有更新,重置PR验证状态

likedislike
openharmony_ci
openharmony_ci成员
3 天前 评论:

感谢提交 Pull Requests!
Thanks for submitting a pull request.

likedislike
sunkaiyang
sunkaiyang
3 天前 评论:

start build

likedislike
openharmony_ci
openharmony_ci成员
3 天前 评论:

本地或库上代码有更新,全量重新构建,重置所有关联PR的验证状态
门禁构建开始,包含静态检查、代码编译【rntpc_br_rnoh0.72编译】,预计在60分钟内完成,门禁结果会同步发送到注册邮箱。您可以通过如下链接跟踪门禁进展:http://dcp.openharmony.cn/workbench/cicd/detail/6a9a912d64650f998bc1b48a/runlist

likedislike
openharmony_ciopenharmony_ci成员
3 天前 添加了label:静态检查失败
openharmony_ci
openharmony_ci成员
3 天前 评论:

代码门禁未通过
您可以通过如下链接查看门禁报告:http://dcp.openharmony.cn/workbench/cicd/detail/6a9a912d64650f998bc1b48a/runlist

静态检查:

# check type result report
1 codeCheck noPass >>>

编译测试:
# Device build result package
1 rntpc_br_rnoh0.72 pending NA

likedislike
sunkaiyangsunkaiyang
2 小时前 强制推送  1 个提交:cb7fe99e-docs: improve OpenHarmony documentation accuracy
openharmony_ciopenharmony_ci成员
2 小时前 删除了label:静态检查失败
openharmony_ci
openharmony_ci成员
2 小时前 评论:

代码有更新,重置PR验证状态

likedislike
openharmony_ci
openharmony_ci成员
2 小时前 评论:

感谢提交 Pull Requests!
Thanks for submitting a pull request.

likedislike