Skip to content

docs: add chagelog#122

Merged
Moskize91 merged 2 commits intomainfrom
docs
Feb 4, 2026
Merged

docs: add chagelog#122
Moskize91 merged 2 commits intomainfrom
docs

Conversation

@Moskize91
Copy link
Contributor

No description provided.

@coderabbitai
Copy link

coderabbitai bot commented Feb 4, 2026

Summary by CodeRabbit

  • New Features

    • Enhanced LaTeX rendering pathway for improved LLM translation processing.
  • Bug Fixes

    • Fixed mixed original and translated text in APPEND_BLOCK mode when documents contain inline mathematical notation.
    • Resolved issue where user-provided prompts were not being included in translations.
  • Documentation

    • Added installation instructions for v0.1.7 with backward compatibility notes for v0.1.6 users.
    • Included migration guide documenting new dependencies and bug fixes.

Walkthrough

This PR adds release notes for v0.1.7 and updates the project version in pyproject.toml. The changelog documents the introduction of a new LaTeX rendering pathway using mathml2latex to replace XSLT-based MathML processing, bug fixes for mixed original/translated text in APPEND_BLOCK mode containing inline MathML, and a fix ensuring user_prompt is included in translations. The mathml2latex dependency (>=0.2.12, <0.3.0) is added as a new requirement, and legacy XSLT stylesheets are removed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • feat: render LaTeX for LLMs #121: Implements the mathml2latex-based LaTeX rendering pathway and removes XSLT stylesheets that are documented as changed in this release notes PR.
🚥 Pre-merge checks | ✅ 1 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive No pull request description was provided by the author. Add a description explaining the changelog updates, including the version bump to v0.1.7, new features, and bug fixes.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The title uses the correct format and is related to the changeset, but contains a typo ('chagelog' instead of 'changelog').

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/changelog/v0.1.7.md`:
- Around line 16-47: Replace bare URLs with Markdown links in the changelog
entries that currently read "Related PR: https://..." and "Related Issue:
https://..."; specifically update the "Related PR:
https://github.com/oomol-lab/epub-translator/pull/121", "Related PR:
https://github.com/oomol-lab/epub-translator/pull/120", and "Related Issue:
https://github.com/oomol-lab/epub-translator/issues/119" lines to use the
Markdown link format (e.g., Related PR:
[`#121`](https://github.com/oomol-lab/epub-translator/pull/121)), keeping the
existing label text like PR/Issue numbers to preserve readability and
consistency with the other inline references such as "Fixed issue [`#119`](...)".

Comment on lines +16 to +47
Related PR: https://github.com/oomol-lab/epub-translator/pull/121

## 🐛 Bug Fixes

### Fixed Mixed Text with Inline Math Formulas (#120)

Fixed issue [#119](https://github.com/oomol-lab/epub-translator/issues/119) where paragraphs containing inline MathML formulas (e.g., `<math display="inline">`) would generate mixed original and translated text instead of properly separated bilingual paragraphs in `APPEND_BLOCK` mode.

**Technical Improvements:**
- Introduced `find_block_depth()` function (now part of public API in `epub_translator.segment`)
- Replaced string-based `is_inline_tag` with element-based `is_inline_element` for better detection
- Enhanced display attribute checking for MathML elements
- Improved inline element hierarchy evaluation

Related PR: https://github.com/oomol-lab/epub-translator/pull/120
Related Issue: https://github.com/oomol-lab/epub-translator/issues/119

### Fixed Missing User Prompt (#118)

Fixed issue [#117](https://github.com/oomol-lab/epub-translator/issues/117) where the `user_prompt` parameter was not being included in the translation template. The prompt is now properly wrapped in `<rules>` tags and passed to the LLM.

**Template Change:**
```jinja
{% if user_prompt -%}
<rules>
{{ user_prompt }}
</rules>
{% endif -%}
```

Related PR: https://github.com/oomol-lab/epub-translator/pull/118
Related Issue: https://github.com/oomol-lab/epub-translator/issues/117
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use Markdown links instead of bare URLs.

Switching the raw PR/issue URLs to Markdown links improves readability and consistency in the changelog.

📝 Suggested edit
-Related PR: https://github.com/oomol-lab/epub-translator/pull/121
+Related PR: [`#121`](https://github.com/oomol-lab/epub-translator/pull/121)

-Related PR: https://github.com/oomol-lab/epub-translator/pull/120
-Related Issue: https://github.com/oomol-lab/epub-translator/issues/119
+Related PR: [`#120`](https://github.com/oomol-lab/epub-translator/pull/120)
+Related Issue: [`#119`](https://github.com/oomol-lab/epub-translator/issues/119)

-Related PR: https://github.com/oomol-lab/epub-translator/pull/118
-Related Issue: https://github.com/oomol-lab/epub-translator/issues/117
+Related PR: [`#118`](https://github.com/oomol-lab/epub-translator/pull/118)
+Related Issue: [`#117`](https://github.com/oomol-lab/epub-translator/issues/117)
🤖 Prompt for AI Agents
In `@docs/changelog/v0.1.7.md` around lines 16 - 47, Replace bare URLs with
Markdown links in the changelog entries that currently read "Related PR:
https://..." and "Related Issue: https://..."; specifically update the "Related
PR: https://github.com/oomol-lab/epub-translator/pull/121", "Related PR:
https://github.com/oomol-lab/epub-translator/pull/120", and "Related Issue:
https://github.com/oomol-lab/epub-translator/issues/119" lines to use the
Markdown link format (e.g., Related PR:
[`#121`](https://github.com/oomol-lab/epub-translator/pull/121)), keeping the
existing label text like PR/Issue numbers to preserve readability and
consistency with the other inline references such as "Fixed issue [`#119`](...)".

@Moskize91 Moskize91 merged commit 15d5446 into main Feb 4, 2026
2 checks passed
@Moskize91 Moskize91 deleted the docs branch February 4, 2026 11:14
@coderabbitai coderabbitai bot mentioned this pull request Feb 5, 2026
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.

1 participant