Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs(docs-infra): show usageNotes only for methods. (#57343)

Browse source 
Prior to this change, function and methods showed their usage notes which resulted in duplicate displays for functions.

Fixes #57339

PR Close #57343
This commit is contained in:
Matthieu Riegler 2024-08-12 12:48:40 +02:00 committed by Andrew Kushnir
parent 4b04a0e61a
commit e404f88092
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
adev/shared-docs/pipeline/api-gen/rendering/templates/class-member.tsx
View file

@ -35,7 +35,7 @@ export function ClassMember(props: {member: MemberEntryRenderable}) {
{isClassMethodEntry(props.member) ? (
props.member.signatures.map((sig, i, signatures) => {
const renderableMember = getFunctionMetadataRenderable(sig);
return <ClassMethodInfo entry={renderableMember} isOverloaded={signatures.length > 1} />;
return <ClassMethodInfo entry={renderableMember} options={{showUsageNotes: true}} />;
})
) : (
<div className={REFERENCE_MEMBER_CARD_ITEM}>

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

@ -17,13 +17,16 @@ import {PARAM_KEYWORD_CLASS_NAME, REFERENCE_MEMBER_CARD_ITEM} from '../styling/c
import {DeprecatedLabel} from './deprecated-label';
import {Parameter} from './parameter';
import {RawHtml} from './raw-html';
import { EntryType } from '../entities';
/**
* Component to render the method-specific parts of a class's API reference.
*/
export function ClassMethodInfo(props: {
entry: FunctionSignatureMetadataRenderable;
isOverloaded?: boolean;
options?: {
showUsageNotes?: boolean,
}
}) {
const entry = props.entry;
@ -47,7 +50,7 @@ export function ClassMethodInfo(props: {
<span className={PARAM_KEYWORD_CLASS_NAME}>@returns</span>
<code>{entry.returnType}</code>
</div>
{entry.htmlUsageNotes ? (
{entry.htmlUsageNotes && props.options?.showUsageNotes ? (
<div className={'docs-usage-notes'}>
<span className={PARAM_KEYWORD_CLASS_NAME}>Usage notes</span>
<RawHtml value={entry.htmlUsageNotes} />