Skip to content

Commit

Permalink
refactor(api-markdown-documenter): Consistent release levels (#23507)
Browse files Browse the repository at this point in the history
Interfaces were previously introduced to represent parameters to HTML
rendering functions. They were added as `@public`, but the related
functions are `@alpha`. This PR makes the interfaces `@alpha` to align
with their corresponding functions.

While this is technically a breaking change, the types strictly exist
for input to functions that are `@alpha`, so this shouldn't have any
impact on users.
  • Loading branch information
Josmithr authored Jan 8, 2025
1 parent 90bc246 commit c77462d
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -650,7 +650,7 @@ export { ReleaseTag }
// @alpha
function renderApiModelAsHtml(options: RenderApiModelAsHtmlOptions): Promise<void>;

// @public
// @alpha
interface RenderApiModelAsHtmlOptions extends ApiItemTransformationOptions, RenderDocumentAsHtmlConfiguration, FileSystemConfiguration {
}

Expand All @@ -674,7 +674,7 @@ export interface RenderDocumentAsHtmlConfiguration extends ToHtmlConfiguration,
// @alpha
function renderDocumentsAsHtml(documents: DocumentNode[], options: RenderDocumentsAsHtmlOptions): Promise<void>;

// @public
// @alpha
interface RenderDocumentsAsHtmlOptions extends RenderDocumentAsHtmlConfiguration, FileSystemConfiguration {
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -647,10 +647,6 @@ export class PlainTextNode extends DocumentationLiteralNodeBase<string> implemen

export { ReleaseTag }

// @public
interface RenderApiModelAsHtmlOptions extends ApiItemTransformationOptions, RenderDocumentAsHtmlConfiguration, FileSystemConfiguration {
}

// @public
function renderApiModelAsMarkdown(options: RenderApiModelAsMarkdownOptions): Promise<void>;

Expand All @@ -668,10 +664,6 @@ function renderDocument_2(document: DocumentNode, config: MarkdownRenderConfigur
export interface RenderDocumentAsHtmlConfiguration extends ToHtmlConfiguration, RenderHtmlConfiguration {
}

// @public
interface RenderDocumentsAsHtmlOptions extends RenderDocumentAsHtmlConfiguration, FileSystemConfiguration {
}

// @public
function renderDocumentsAsMarkdown(documents: DocumentNode[], options: RenderDocumentsAsMarkdownOptions): Promise<void>;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -625,10 +625,6 @@ export class PlainTextNode extends DocumentationLiteralNodeBase<string> implemen

export { ReleaseTag }

// @public
interface RenderApiModelAsHtmlOptions extends ApiItemTransformationOptions, RenderDocumentAsHtmlConfiguration, FileSystemConfiguration {
}

// @public
function renderApiModelAsMarkdown(options: RenderApiModelAsMarkdownOptions): Promise<void>;

Expand All @@ -646,10 +642,6 @@ function renderDocument_2(document: DocumentNode, config: MarkdownRenderConfigur
export interface RenderDocumentAsHtmlConfiguration extends ToHtmlConfiguration, RenderHtmlConfiguration {
}

// @public
interface RenderDocumentsAsHtmlOptions extends RenderDocumentAsHtmlConfiguration, FileSystemConfiguration {
}

// @public
function renderDocumentsAsMarkdown(documents: DocumentNode[], options: RenderDocumentsAsMarkdownOptions): Promise<void>;

Expand Down
4 changes: 2 additions & 2 deletions tools/api-markdown-documenter/src/RenderHtml.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { type RenderDocumentAsHtmlConfiguration, renderDocumentAsHtml } from "./
/**
* API Model HTML rendering options.
*
* @public
* @alpha
*/
export interface RenderApiModelAsHtmlOptions
extends ApiItemTransformationOptions,
Expand Down Expand Up @@ -55,7 +55,7 @@ export async function renderApiModelAsHtml(options: RenderApiModelAsHtmlOptions)
/**
* Options for rendering {@link DocumentNode}s as HTML.
*
* @public
* @alpha
*/
export interface RenderDocumentsAsHtmlOptions
extends RenderDocumentAsHtmlConfiguration,
Expand Down

0 comments on commit c77462d

Please sign in to comment.