Skip to content

chore(repo): Fix typedoc paramextension tag #6990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 22, 2025
+18 −6
Merged

chore(repo): Fix typedoc paramextension tag #6990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e2e4f6
chore(repo): Fix typedoc paramextension tag
alexisintech Oct 14, 2025
c80466d
add empty changeset
alexisintech Oct 14, 2025
6dd02ca
remove random line
alexisintech Oct 14, 2025
bdc2522
code suggestion
alexisintech Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/five-schools-repair.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
Comment on lines +1 to +2
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Complete the changeset file for automated releases.

This changeset file is incomplete. According to the project's coding guidelines, automated releases require proper Changesets format. A valid changeset should include:

  1. Package names and version bump types between the YAML delimiters:
---
"@clerk/backend": patch
---
  1. A description of the changes below the front matter:
---
"@clerk/backend": patch
---

Fix typedoc paramExtension tag injection to work without "## Returns" heading
🧰 Tools
🪛 LanguageTool

[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- ---

(QB_NEW_DE)

🤖 Prompt for AI Agents 
In .changeset/five-schools-repair.md around lines 1 to 2, the changeset is
empty; add a proper Changesets front matter containing the package name(s) and
the version bump type (patch/minor/major) between the YAML delimiters and then
add a short description of the change below the front matter so automated
releases can parse it (e.g., include "@clerk/backend": patch in the YAML and a
one-line description of the fix beneath).

22 changes: 16 additions & 6 deletions .typedoc/custom-theme.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,22 @@ class ClerkMarkdownThemeContext extends MarkdownThemeContext {
if (paramExtensionTag) {
const stuff = this.helpers.getCommentParts(paramExtensionTag.content);

// Find the index of the item that contains '## Returns'
const index = splitOutput.findIndex(item => item.includes('## Returns'));

// If the index is found, insert the stuff before it
if (index !== -1) {
splitOutput.splice(index, 0, stuff);
// Find the index of the item that contains '## Parameters'
const parametersIndex = splitOutput.findIndex(item => item.includes('## Parameters'));

if (parametersIndex !== -1) {
// Find the immediate next heading after '## Parameters'
const nextHeadingIndex = splitOutput.findIndex((item, index) => {
// Skip the items before the parameters
if (index <= parametersIndex) return false;
// Find the next heading
return item.startsWith('##') || item.startsWith('\n##');
});

// Insert the stuff before the next heading
// (or at the end of the entire page if no heading found)
const insertIndex = nextHeadingIndex !== -1 ? nextHeadingIndex : splitOutput.length;
splitOutput.splice(insertIndex, 0, stuff);
}
}

Expand Down
Loading