Skip to content

Commit bc12f17

Browse files
committed
docs(CHANGES) Documented class fields
why: The unreleased entry did not record that class fields now carry descriptions where the API reference renders them. what: - Note the described fields under Documentation
1 parent ceb8bb1 commit bc12f17

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

CHANGES

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ $ uv add libvcs --prerelease allow
2020
_Notes on the upcoming release will go here._
2121
<!-- END PLACEHOLDER - ADD NEW CHANGELOG ENTRIES BELOW THIS LINE -->
2222

23+
### Documentation
24+
25+
#### Class fields describe themselves in the API reference (#548)
26+
27+
The URL, command, and sync types — parsed URLs, rules, remotes, status, and
28+
the subprocess wrapper — now say what each field holds. They previously
29+
reached the rendered API reference as "Alias for field number 0" or as a
30+
bare name carrying only its type.
31+
2332
## libvcs 0.45.1 (2026-07-11)
2433

2534
libvcs 0.45.1 unbreaks test suites that build their documentation before running pytest: the bundled pytest plugin no longer overrides pytest's own collection-ignore rules, so generated `_build/` output stops aborting collection. The documentation now runs every Python example as a doctest against real temporary repositories, which surfaced and corrected examples that had drifted from the API.

0 commit comments

Comments
 (0)