Skip to content

Commit a2e73f4

Browse files
Add summary to FunctionLike.return (#109)
1 parent 2424005 commit a2e73f4

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
3434

3535
- Added a `"rest"` field to parameters. ([#83](https://github.com/webcomponents/custom-elements-manifest/pull/83))
3636

37+
- Added an optional `summary` field to Function and Method return types. ([#109](https://github.com/webcomponents/custom-elements-manifest/pull/109))
38+
3739
<!-- ### Removed -->
3840

3941
### Fixed

schema.d.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -697,6 +697,15 @@ export interface FunctionLike {
697697

698698
return?: {
699699
type?: Type;
700+
701+
/**
702+
* A markdown summary suitable for display in a listing.
703+
*/
704+
summary?: string;
705+
706+
/**
707+
* A markdown description.
708+
*/
700709
description?: string;
701710
};
702711
}

schema.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,11 @@
190190
"return": {
191191
"properties": {
192192
"description": {
193+
"description": "A markdown description.",
194+
"type": "string"
195+
},
196+
"summary": {
197+
"description": "A markdown summary suitable for display in a listing.",
193198
"type": "string"
194199
},
195200
"type": {
@@ -511,6 +516,11 @@
511516
"return": {
512517
"properties": {
513518
"description": {
519+
"description": "A markdown description.",
520+
"type": "string"
521+
},
522+
"summary": {
523+
"description": "A markdown summary suitable for display in a listing.",
514524
"type": "string"
515525
},
516526
"type": {
@@ -633,6 +643,11 @@
633643
"return": {
634644
"properties": {
635645
"description": {
646+
"description": "A markdown description.",
647+
"type": "string"
648+
},
649+
"summary": {
650+
"description": "A markdown summary suitable for display in a listing.",
636651
"type": "string"
637652
},
638653
"type": {
@@ -812,6 +827,11 @@
812827
"return": {
813828
"properties": {
814829
"description": {
830+
"description": "A markdown description.",
831+
"type": "string"
832+
},
833+
"summary": {
834+
"description": "A markdown summary suitable for display in a listing.",
815835
"type": "string"
816836
},
817837
"type": {

0 commit comments

Comments
 (0)