Skip to content

docs: trim repetitive feature list in README header#6

Merged
hutaobo merged 2 commits into
mainfrom
claude/zen-ishizaka-19fb62
Jun 12, 2026
Merged

docs: trim repetitive feature list in README header#6
hutaobo merged 2 commits into
mainfrom
claude/zen-ishizaka-19fb62

Conversation

@hutaobo

@hutaobo hutaobo commented Jun 12, 2026

Copy link
Copy Markdown
Owner

Collapses the three prose enumerations of the nine feature areas (tagline, figure caption, intro) into a single concise tagline. The overview figure and the section table now carry the enumeration — no prose repetition.

🤖 Generated with Claude Code

Summary by Sourcery

简化并去重 README 中的特性描述,同时将概览图切换为 SVG 资源。

Documentation:

  • 精简 README 的标题标语和章节引言,避免重复列举九大特性。
  • 将 README 和文档中的 PNG 概览图替换为 SVG 版本,并将该 SVG 资源添加到文档的静态图像中。
Original summary in English

Summary by Sourcery

Simplify and deduplicate the README’s feature description while switching overview graphics to SVG assets.

Documentation:

  • Streamline the README header tagline and section introduction to avoid repeating the nine-feature enumeration.
  • Replace PNG overview figures with SVG versions across README and documentation, adding the SVG asset to the docs static figures.

hutaobo and others added 2 commits June 12, 2026 15:57
Swap the raster nine-feature overview (PNG) for a vector SVG across the
README and docs (index, nine-feature-overview), and drop the orphaned PNG.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The nine feature areas were enumerated in prose three times around the
overview figure (tagline, figure caption, intro). Collapse to a concise
tagline, drop the redundant caption, and let the figure + section table
carry the enumeration.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 12, 2026 14:02
@hutaobo hutaobo merged commit 8c80be5 into main Jun 12, 2026
2 of 8 checks passed
@sourcery-ai

sourcery-ai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor
审阅者指南(在小型 PR 上折叠显示)

审阅者指南

更新 README 和文档,将冗长、重复的功能罗列替换为精炼标语,将概览图片从 PNG 切换为 SVG,并在加入新的 SVG 资源的同时,进一步澄清九个部分的整体结构。

文件级变更

变更 详情 文件
精简 README 头部文案并澄清章节组织结构,同时避免重复枚举功能。
  • 在 README 标语中,用关于加载、分析和解释 Xenium 空间数据的简洁描述,替换了对九大功能区域的冗长文字列表。
  • 删除冗余的图注段落,该段落对与概览图和章节表相同的九大功能区域进行了重复描述。
  • 重写引言句,强调围绕九个章节及其规范入口进行组织,而不是重复罗列功能列表。
README.md
将概览图资源在 README 和文档中统一标准化为 SVG,并添加新的 SVG 文件。
  • 在 README 中,将概览图片引用从 PNG 文件更新为新的 SVG 文件,同时保持替代文本和布局一致。
  • 在 Sphinx 文档的首页和九大功能概览页面中,将图片从引用 PNG 更新为引用 SVG。
  • 在 docs 静态图片目录中添加新的 SVG 概览图资源。
README.md
docs/index.md
docs/user-guide/nine-feature-overview.md
docs/_static/figures/pyxenium-nine-feature-overview.svg

提示与命令

与 Sourcery 交互

  • 触发新审阅: 在拉取请求中评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审阅评论。
  • 从审阅评论生成 GitHub issue: 通过回复某条审阅评论,要求 Sourcery 从该评论创建一个 issue。你也可以在审阅评论下回复 @sourcery-ai issue 来从该评论创建 issue。
  • 生成拉取请求标题: 在拉取请求标题中的任意位置写上 @sourcery-ai,即可随时生成标题。你也可以在拉取请求中评论 @sourcery-ai title 来(重新)生成标题。
  • 生成拉取请求摘要: 在拉取请求正文的任意位置写上 @sourcery-ai summary,即可在你想要的位置生成 PR 摘要。你也可以在拉取请求中评论 @sourcery-ai summary 来(重新)生成摘要。
  • 生成审阅者指南: 在拉取请求中评论 @sourcery-ai guide,即可随时(重新)生成审阅者指南。
  • 解决所有 Sourcery 评论: 在拉取请求中评论 @sourcery-ai resolve,即可标记解决所有 Sourcery 评论。当你已经处理完所有评论且不想再看到它们时,这会非常有用。
  • 清除所有 Sourcery 审阅: 在拉取请求中评论 @sourcery-ai dismiss,即可清除所有现有的 Sourcery 审阅。尤其适用于你想从头开始新的审阅时——别忘了再评论 @sourcery-ai review 来触发新的审阅!

自定义你的体验

访问你的控制面板以:

  • 启用或禁用审阅功能,例如 Sourcery 生成的拉取请求摘要、审阅者指南等。
  • 更改审阅语言。
  • 添加、删除或编辑自定义审阅指令。
  • 调整其他审阅设置。

获取帮助

Original review guide in English
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the README and docs to replace a verbose, repetitive feature enumeration with a concise tagline, switch overview images from PNG to SVG, and clarify the nine-section organization while adding the new SVG asset.

File-Level Changes

Change Details Files
Simplified README header copy and clarified section organization while avoiding repeated feature enumeration.
  • Replaced long prose list of nine feature areas in the README tagline with a concise description of loading, analyzing, and interpreting Xenium spatial data.
  • Removed the redundant figure caption paragraph describing the same nine feature areas as the overview figure and section table.
  • Rephrased the introduction sentence to emphasize organization around nine sections with canonical entry points instead of repeating the feature list.
README.md
Standardized the overview figure asset to an SVG across README and documentation, adding the new SVG file.
  • Updated the overview image reference in the README from the PNG file to the new SVG file while keeping alt text and layout consistent.
  • Updated Sphinx documentation figures in index and nine-feature overview pages to reference the SVG instead of the PNG.
  • Added the new SVG overview figure asset under the docs static figures directory.
README.md
docs/index.md
docs/user-guide/nine-feature-overview.md
docs/_static/figures/pyxenium-nine-feature-overview.svg

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

嘿,我已经审查了你的更改,看起来很棒!


Sourcery 对开源项目是免费的 —— 如果你喜欢我们的审查,请考虑分享它们 ✨
帮我变得更有用!请在每条评论上点击 👍 或 👎,我会根据你的反馈改进审查质量。
Original comment in English

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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR streamlines top-level documentation by removing repetitive prose lists of pyXenium’s “nine feature areas” in the README header and switching the “nine-feature overview” graphic from PNG to SVG where it’s embedded in the README and Sphinx docs.

Changes:

  • Replace the README header’s long feature enumeration with a concise one-line tagline.
  • Switch the embedded “nine-feature overview” image from PNG to SVG in the README.
  • Update Sphinx {figure} directives to reference the SVG asset in the docs index and the “nine-feature overview” page.

Reviewed changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated no comments.

File Description
README.md Simplifies the header tagline and updates the overview image reference to SVG while removing redundant prose.
docs/user-guide/nine-feature-overview.md Updates the MyST {figure} to use the SVG overview graphic.
docs/index.md Updates the homepage {figure} to use the SVG overview graphic.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants