Skip to content

Commit

Permalink
Can we link users to plugin docs?
Browse files Browse the repository at this point in the history
  • Loading branch information
snejus committed Dec 4, 2024
1 parent 28779c3 commit caacf41
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion extra/release.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@
(r"^ +( - )", r"\1"), # adjust nested bullet points indent
(r"^(\w[^\n]{,80}):(?=\n\n[^ ])", r"### \1"), # make sections headers
(r"^(\w[^\n]{81,}):(?=\n\n[^ ])", r"**\1**"), # make sections headers
(r"^- `/?plugins/(\w+)`:?", r"- Plugin **`\1`**:"), # highlight plugins
(
r"^- `/?plugins/(\w+)`:?",
r"- Plugin [\1](https://beets.readthedocs.io/en/stable/plugins/\1.html):",
), # highlight plugins
(r"^- `(\w+)-cmd`:?", r"- Command **`\1`**:"), # highlight commands
(r"### [^\n]+\n+(?=### )", ""), # remove empty sections
]
Expand Down
2 changes: 1 addition & 1 deletion test/test_release.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ def md_changelog():
return r"""### New features
- Command **`list`**: Update.
- Plugin **`substitute`**: Some substitute multi-line change. :bug: (\#5467)
- Plugin [substitute](https://beets.readthedocs.io/en/stable/plugins/substitute.html): Some substitute multi-line change. :bug: (\#5467)
You can do something with this command:
Expand Down

0 comments on commit caacf41

Please sign in to comment.