Skip to content

Tighten documentation quality: restore KIE training snippet and fix docstring rendering in visualization#2080

Draft
Copilot wants to merge 10 commits into
mainfrom
copilot/improvement-check-rework-docs-docstrings
Draft

Tighten documentation quality: restore KIE training snippet and fix docstring rendering in visualization#2080
Copilot wants to merge 10 commits into
mainfrom
copilot/improvement-check-rework-docs-docstrings

Conversation

Copilot AI commented Jun 22, 2026

Copy link
Copy Markdown

This updates documentation quality in two focused areas: it restores missing user guidance in custom model training docs and removes a docstring formatting issue that caused Sphinx/docutils rendering warnings. The goal is to keep feature docs complete while improving generated documentation output without expanding KIE scope.

  • Docs completeness: custom model training

    • Restored the removed KIE detection model loading snippet in docs/source/using_doctr/custom_models_training.rst.
    • Keeps KIE coverage at existing scope (no new KIE feature docs added), while preserving a previously documented loading path.
  • Docstring rendering correctness

    • Updated doctr/utils/visualization.py (draw_boxes) docstring to avoid reStructuredText parsing issues in generated docs.
    • Adjusted punctuation and inline formatting so the API docs render cleanly.
def draw_boxes(...):
    """Draw an array of relative straight boxes on an image.

    Args:
        boxes: array of relative boxes, of shape ``(*, 4)``
        ...
    """

Copilot AI changed the title [WIP] Improve documentation and docstrings Fix inconsistent and outdated docstring formatting across model files Jun 22, 2026
Copilot AI changed the title Fix inconsistent and outdated docstring formatting across model files Fix docstring formatting and improve documentation quality Jun 22, 2026
Copilot AI changed the title Fix docstring formatting and improve documentation quality docs: improve documentation coverage and user experience Jun 22, 2026
Copilot AI changed the title docs: improve documentation coverage and user experience Trim KIE from user docs and tighten related doc references/docstrings Jun 22, 2026
Copilot AI changed the title Trim KIE from user docs and tighten related doc references/docstrings docs: improve user-friendliness across quickstart and model docs Jun 22, 2026
Copilot AI changed the title docs: improve user-friendliness across quickstart and model docs docs: restore KIE detection model loading snippet Jun 22, 2026
Copilot AI changed the title docs: restore KIE detection model loading snippet Tighten documentation quality: restore KIE training snippet and fix docstring rendering in visualization Jun 22, 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.

2 participants