Skip to content

fix: (docs)remove bold formatting from speech recognition headings#414

Merged
deepin-bot[bot] merged 1 commit intolinuxdeepin:release/eaglefrom
pppanghu77:release/eagle
Jan 19, 2026
Merged

fix: (docs)remove bold formatting from speech recognition headings#414
deepin-bot[bot] merged 1 commit intolinuxdeepin:release/eaglefrom
pppanghu77:release/eagle

Conversation

@pppanghu77
Copy link
Contributor

@pppanghu77 pppanghu77 commented Jan 19, 2026

  • Remove bold formatting (***) from "语音听写"/"語音聽寫" headings
  • Update Chinese (zh_CN) and Traditional Chinese (zh_TW) documentation files
  • Affects both d_editor.md and p_editor.md files in the editor component

Log: fix: (docs)remove bold formatting from speech recognition headings

Bug: https://pms.uniontech.com/bug-view-344909.html

Summary by Sourcery

Documentation:

  • Remove bold styling from the speech recognition headings in Simplified and Traditional Chinese editor documentation to match heading style conventions.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 19, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Removes unnecessary bold formatting from the Chinese and Traditional Chinese 'speech recognition/dictation' headings in the editor documentation to align with the intended heading style, without altering any surrounding content or functionality.

File-Level Changes

Change Details Files
Normalize the '语音听写' heading style in Simplified Chinese editor documentation.
  • Change the level-3 heading text from bolded '语音听写' to a plain level-3 heading without inline bold formatting
  • Keep the subsequent instruction list and other surrounding content unchanged
src/assets/deepin-editor/editor/zh_CN/p_editor.md
Normalize the '語音聽寫' heading style in Traditional Chinese editor documentation.
  • Change the level-3 heading text from bolded '語音聽寫' to a plain level-3 heading without inline bold formatting
  • Keep the subsequent instruction list and other surrounding content unchanged
src/assets/deepin-editor/editor/zh_TW/p_editor.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

- Remove bold formatting (***) from "语音听写"/"語音聽寫" headings
- Update Chinese (zh_CN) and Traditional Chinese (zh_TW) documentation files
- Affects both d_editor.md and p_editor.md files in the editor component

 Log: fix: (docs)remove bold formatting from speech recognition headings

 Bug: https://pms.uniontech.com/bug-view-344909.html
@deepin-ci-robot
Copy link

deepin pr auto review

这段代码的 diff 显示了对两个文档文件(p_editor.md)的修改,分别是简体中文版本和繁体中文版本。以下是对这段 diff 的审查和改进意见:

1. 语法逻辑审查

  • 修改内容:将三级标题的 Markdown 语法从 ### **语音听写** 修改为 ### 语音听写(繁体中文版本同理)。
  • 分析
    • 原始写法 ### **语音听写** 是在三级标题中使用了加粗语法 **。这在 Markdown 中是合法的,但通常标题本身已经具有强调作用,再加粗显得冗余。
    • 修改后的 ### 语音听写 去掉了加粗,更符合 Markdown 的最佳实践。
  • 结论:修改合理,语法逻辑正确。

2. 代码质量审查

  • 一致性
    • 两个文件(zh_CNzh_TW)的修改保持了一致性,都去掉了标题中的加粗符号。
    • 文档中其他部分的标题格式(如 ### 只读模式)也没有使用加粗,因此这次修改使文档风格更加统一。
  • 可读性
    • 去掉加粗后,标题仍然清晰可读,且不会影响渲染效果。
  • 结论:修改提高了文档的一致性和可读性。

3. 代码性能审查

  • 分析
    • Markdown 文件的修改不会影响程序性能,因为这是文档内容,不涉及代码逻辑。
  • 结论:无性能影响。

4. 代码安全审查

  • 分析
    • 修改仅涉及文档格式,不涉及代码逻辑、输入验证或数据处理,因此没有安全隐患。
  • 结论:无安全问题。

5. 改进建议

虽然当前的修改是合理的,但可以进一步优化文档的规范性:

  • 统一标题格式:建议检查整个文档中的所有标题,确保它们都不使用加粗(或都使用加粗),以保持一致性。
  • 添加空格:Markdown 标题的 # 符号后建议加一个空格(如 ### 语音听写),当前代码已经符合这一规范。
  • 图片命名一致性
    • 简体中文版本中图片命名为 read-only.png,而繁体中文版本中为 read_only.png。建议统一命名风格(如全部使用连字符或下划线)。
  • 翻译准确性
    • 繁体中文版本的翻译(如「語音聽寫」)是准确的,但可以检查其他术语是否与简体中文版本保持一致(如「光标」与「游標」)。

总结

这段 diff 的修改是合理的,去除了标题中冗余的加粗符号,提高了文档的一致性和可读性。没有发现语法、逻辑、性能或安全问题。建议进一步优化文档的规范性和一致性。

@deepin-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: lzwind, pppanghu77

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@pppanghu77
Copy link
Contributor Author

/forcemerge

@deepin-bot
Copy link
Contributor

deepin-bot bot commented Jan 19, 2026

This pr force merged! (status: unstable)

@deepin-bot deepin-bot bot merged commit 414e16a into linuxdeepin:release/eagle Jan 19, 2026
19 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants