Skip to content

Fix Documentation CI failure by correcting Loda __init__ docstring field-list formatting#364

Closed
justinuliu with Copilot wants to merge 3 commits into
mainfrom
copilot/fix-documentation-github-actions
Closed

Fix Documentation CI failure by correcting Loda __init__ docstring field-list formatting#364
justinuliu with Copilot wants to merge 3 commits into
mainfrom
copilot/fix-documentation-github-actions

Conversation

Copilot AI commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

The Documentation GitHub Actions job failed because Sphinx (-W -n) escalated a docutils warning in capymoa.anomaly._loda.Loda.__init__ to an error. The warning was caused by malformed RST field-list structure in the constructor docstring.

  • Root cause

    • Loda.__init__ docstring started parameter fields immediately after the summary line, which docutils parsed as an invalid block transition (unexpected unindent).
  • Change made

    • Updated /src/capymoa/anomaly/_loda.py to insert the required blank line between the summary sentence and :param field list in Loda.__init__.
  • Impact

    • Removes the docutils warning that was failing docs generation, without changing runtime behavior.
def __init__(...):
    """Initialize the Loda anomaly detector.

    :param schema: Schema of the data stream.
    :param n_projections: Number of random projection histograms in the ensemble.
    ...
    """

Copilot AI changed the title [WIP] Fix failing GitHub Actions job Documentation Fix Documentation CI failure by correcting Loda __init__ docstring field-list formatting Jun 23, 2026
Copilot AI requested a review from justinuliu June 23, 2026 22:36
@justinuliu justinuliu marked this pull request as ready for review June 23, 2026 22:39
@justinuliu justinuliu closed this Jun 23, 2026
@justinuliu justinuliu deleted the copilot/fix-documentation-github-actions branch June 23, 2026 23:00
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