Skip to content

Commit b228355

Browse files
JeanMechethePunderWoman
authored andcommitted
docs(docs-infra): prevent from showing duplicate usage blocks in functions API docs
fixes angular#66398
1 parent a056413 commit b228355

3 files changed

Lines changed: 18 additions & 23 deletions

File tree

adev/shared-docs/pipeline/api-gen/rendering/templates/class-method-info.tsx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,18 @@ import {
1212
ParameterEntryRenderable,
1313
} from '../entities/renderables.mjs';
1414
import {PARAM_KEYWORD_CLASS_NAME, REFERENCE_MEMBER_CARD_ITEM} from '../styling/css-classes.mjs';
15+
import {CodeSymbol} from './code-symbols';
1516
import {DeprecatedLabel} from './deprecated-label';
1617
import {Parameter} from './parameter';
1718
import {RawHtml} from './raw-html';
18-
import {CodeSymbol} from './code-symbols';
1919

2020
/**
2121
* Component to render the method-specific parts of a class's API reference.
2222
*/
23-
export function ClassMethodInfo(props: {entry: FunctionSignatureMetadataRenderable}) {
23+
export function ClassMethodInfo(props: {
24+
entry: FunctionSignatureMetadataRenderable;
25+
hideUsageNotes?: boolean;
26+
}) {
2427
const entry = props.entry;
2528

2629
return (
@@ -43,7 +46,7 @@ export function ClassMethodInfo(props: {entry: FunctionSignatureMetadataRenderab
4346
<span className={PARAM_KEYWORD_CLASS_NAME}>@returns</span>
4447
<CodeSymbol code={entry.returnType} />
4548
</div>
46-
{entry.htmlUsageNotes ? (
49+
{entry.htmlUsageNotes && !props.hideUsageNotes ? (
4750
<div className={'docs-usage-notes'}>
4851
<span className={'docs-usage-notes-heading'}>Usage notes</span>
4952
<RawHtml value={entry.htmlUsageNotes} />

adev/shared-docs/pipeline/api-gen/rendering/templates/function-reference.tsx

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,22 @@ import {printInitializerFunctionSignatureLine} from '../transforms/code-transfor
2222
import {getFunctionMetadataRenderable} from '../transforms/function-transforms.mjs';
2323
import {ClassMethodInfo} from './class-method-info';
2424
import {CodeSymbol} from './code-symbols';
25+
import {DeprecationWarning} from './deprecation-warning';
2526
import {HeaderApi} from './header-api';
2627
import {HighlightTypeScript} from './highlight-ts';
2728
import {SectionApi} from './section-api';
2829
import {SectionDescription} from './section-description';
2930
import {SectionUsageNotes} from './section-usage-notes';
30-
import {DeprecationWarning} from './deprecation-warning';
3131

3232
export const signatureCard = (
3333
name: string,
3434
signature: FunctionSignatureMetadataRenderable,
35-
opts: {id: string},
36-
printSignaturesAsHeader: boolean,
35+
opts: {id: string; printSignaturesAsHeader: boolean; hideUsageNotes?: boolean},
3736
) => {
3837
return (
3938
<div id={opts.id} class={REFERENCE_MEMBER_CARD}>
4039
<header class={REFERENCE_MEMBER_CARD_HEADER}>
41-
{printSignaturesAsHeader ? (
40+
{opts.printSignaturesAsHeader ? (
4241
<HighlightTypeScript
4342
code={printInitializerFunctionSignatureLine(
4443
name,
@@ -57,7 +56,7 @@ export const signatureCard = (
5756
)}
5857
</header>
5958
<div class={REFERENCE_MEMBER_CARD_BODY}>
60-
<ClassMethodInfo entry={signature} />
59+
<ClassMethodInfo entry={signature} hideUsageNotes={opts.hideUsageNotes} />
6160
</div>
6261
</div>
6362
);
@@ -75,14 +74,11 @@ export function FunctionReference(entry: FunctionEntryRenderable) {
7574
<SectionApi entry={entry} />
7675
<div className={REFERENCE_MEMBERS}>
7776
{entry.signatures.map((s, i) =>
78-
signatureCard(
79-
s.name,
80-
getFunctionMetadataRenderable(s, entry.moduleName, entry.repo),
81-
{
82-
id: `${s.name}_${i}`,
83-
},
77+
signatureCard(s.name, getFunctionMetadataRenderable(s, entry.moduleName, entry.repo), {
78+
id: `${s.name}_${i}`,
8479
printSignaturesAsHeader,
85-
),
80+
hideUsageNotes: true,
81+
}),
8682
)}
8783
</div>
8884

adev/shared-docs/pipeline/api-gen/rendering/templates/initializer-api-function.tsx

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,10 @@ export function InitializerApiFunction(entry: InitializerApiFunctionRenderable)
4040

4141
<div class={REFERENCE_MEMBERS}>
4242
{entry.callFunction.signatures.map((s, i) =>
43-
signatureCard(
44-
s.name,
45-
getFunctionMetadataRenderable(s, entry.moduleName, entry.repo),
46-
{
47-
id: `${s.name}_${i}`,
48-
},
43+
signatureCard(s.name, getFunctionMetadataRenderable(s, entry.moduleName, entry.repo), {
44+
id: `${s.name}_${i}`,
4945
printSignaturesAsHeader,
50-
),
46+
}),
5147
)}
5248

5349
{entry.subFunctions.reduce(
@@ -59,8 +55,8 @@ export function InitializerApiFunction(entry: InitializerApiFunctionRenderable)
5955
getFunctionMetadataRenderable(s, entry.moduleName, entry.repo),
6056
{
6157
id: `${entry.name}_${s.name}_${i}`,
58+
printSignaturesAsHeader,
6259
},
63-
printSignaturesAsHeader,
6460
),
6561
),
6662
],

0 commit comments

Comments
 (0)