Fix StopIteration in restore_yaml_comments when default_data ends with a comment or blank line

[gaoflow]

What

restore_yaml_comments in confuse/yaml_util.py uses a bare next() call inside an inner while True loop to scan past comment or blank lines in default_data. If the file ends on a comment or blank line — which is extremely common, since editors and most YAML files append a trailing newline after the last comment — next() raises StopIteration, which propagates out of the function entirely and crashes any caller.

The most visible symptom: Configuration.dump() raises StopIteration when the application's config_default.yaml has an empty or comment-only last line (issue #148).

Root cause

while True:
    line = next(default_lines)   # raises StopIteration at EOF, no catch
    ...

Fix

Wrap the next() call in a try/except StopIteration, set line = None, and break out of both the inner and outer loops. The trailing comment is silently discarded (there is no following key to attach it to), matching the documented behaviour for orphaned comments.

Tests

Three regression tests added to test/test_yaml.py:

• test_trailing_comment_does_not_raise — default_data ends with # trailing comment
• test_trailing_blank_line_does_not_raise — default_data ends with \n\n
• test_comments_still_restored_before_key — verifies normal comment restoration still works

All 295 existing tests continue to pass.

Closes #148.

---

This pull request was prepared with the assistance of AI, under my direction and review.

[github-actions]

Thank you for the PR! The changelog has not been updated, so here is a friendly reminder to check if you need to add an entry.

[gaoflow]

Added a changelog entry under Unreleased for the restore_yaml_comments fix.

Verification:

• uv run --group lint sphinx-lint --enable all --disable default-role docs/changelog.rst -> passed
• uv run --group dev pytest test/test_yaml.py -q -> 23 passed
• git diff --check -> passed