Commit 6dda294
docs(agents): fix incorrect playbook examples
Validation against the actual source code surfaced three inaccuracies:
* add-version-provider.md: `composer_provider.py` was labelled
`JSON file with non-standard layout`, but it is actually the
simplest `JsonProvider` (just `filename` and `indent`). Replace
with `npm_provider.py` for the non-standard layout / multi-file
case, and re-introduce composer as the simplest-case example.
* add-changelog-format.md: pointed agents at
`restructuredtext.py` as an example of overriding only
`parse_version_from_title` + `parse_title_level`. RST actually
overrides `get_metadata_from_file` because its titles span
multiple lines. Re-route the line-anchored example to
`markdown.py` / `asciidoc.py` / `textile.py` and keep RST as
the multi-line example. Add the multi-line escape hatch to Step 2
and clarify that the template extension comes from the class
attribute, not the format name.
* architecture.md: claimed entry points are loaded `lazily`. Only
providers are looked up at call time; `KNOWN_CHANGELOG_FORMATS`
is populated at module import time. Drop the misleading qualifier.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>1 parent ac589a8 commit 6dda294
3 files changed
Lines changed: 12 additions & 9 deletions
File tree
- docs/contributing
- agents/playbooks
Lines changed: 7 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
17 | 17 | | |
18 | | - | |
19 | | - | |
20 | | - | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
| 31 | + | |
| 32 | + | |
31 | 33 | | |
32 | 34 | | |
33 | 35 | | |
| |||
Lines changed: 4 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
19 | | - | |
20 | | - | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
21 | 22 | | |
22 | 23 | | |
23 | 24 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
| 40 | + | |
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| |||
0 commit comments