DGI9-653: Describe the known issue.

[adam-vessey]

Summary by CodeRabbit

• Documentation
  • Updated Known Issues section with guidance on archival FOXML patches and potential migration exceptions related to stream operations.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

README.md documentation is updated with a new bullet point in the Known Issues section describing the necessity of archival FOXML patch for iqb/substream, referencing related issues and potential MigrateExceptions from stream wrapper concerns.

Changes

Cohort / File(s)	Change Summary
Documentation Update README.md	Added known issue about FOXML patch requirement for iqb/substream, including references to patch and related GitHub issues, and notes on potential MigrateExceptions

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

📝✨ A rabbit hops through README files,
Adding notes of known travails,
FOXML patches, streams that flow,
Documentation helps us grow! 🐰

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly references the PR objective (DGI9-653) and accurately describes the main change: documenting a known issue in the README.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/describe-known-issue

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 923e309 and 0cdc480.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: PHPUnit / Drupal 10.5 | PHP 8.4
• GitHub Check: PHPUnit / Drupal 10.4 | PHP 8.4
• GitHub Check: PHPUnit / Drupal 10.3 | PHP 8.2
• GitHub Check: PHPUnit / Drupal 10.4 | PHP 8.3
• GitHub Check: PHPUnit / Drupal 10.5 | PHP 8.3

🔇 Additional comments (2)

README.md (2)

97-98: Documentation is clear and appropriately positioned.

The new bullet point:

• Follows the existing Known Issues format and style
• Provides comprehensive technical context with relevant links
• Describes the problem, references related issues, and points to affected code
• Properly documents the workaround (patch) and potential symptoms (MigrateExceptions)

---

97-98: External GitHub references in Known Issues documentation are appropriate.

The referenced repositories (iqb/Morgue, iqb/SubStream, and dgi_migrate) are legitimate and active. Linking to external issues and code locations is standard practice when documenting known issues and their workarounds. No changes needed.

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

• JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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