Skip to content

Commit df728e7

Browse files
[Azure Mgmt Generator] Add return descriptions for generated pageable methods (#51967)
* Initial plan * Fix pageable method return description generation in Azure Management Generator Co-authored-by: ArcturusZhang <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: ArcturusZhang <[email protected]>
1 parent b8423b0 commit df728e7

File tree

7 files changed

+17
-1
lines changed

7 files changed

+17
-1
lines changed

eng/packages/http-client-csharp-mgmt/generator/Azure.Generator.Management/src/Providers/OperationMethodProviders/PageableOperationMethodProvider.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
using Microsoft.TypeSpec.Generator.Primitives;
1313
using Microsoft.TypeSpec.Generator.Providers;
1414
using Microsoft.TypeSpec.Generator.Statements;
15+
using System;
1516
using System.Collections.Generic;
1617
using static Microsoft.TypeSpec.Generator.Snippets.Snippet;
1718

@@ -84,12 +85,15 @@ protected MethodSignature CreateSignature()
8485
? new CSharpType(typeof(AsyncPageable<>), _actualItemType)
8586
: new CSharpType(typeof(Pageable<>), _actualItemType);
8687

88+
// Generate return description for pageable methods
89+
FormattableString returnDescription = $"A collection of {_actualItemType:C} that may take multiple service requests to iterate over.";
90+
8791
return new MethodSignature(
8892
_methodName,
8993
_convenienceMethod.Signature.Description,
9094
_convenienceMethod.Signature.Modifiers,
9195
returnType,
92-
_convenienceMethod.Signature.ReturnDescription,
96+
returnDescription,
9397
OperationMethodParameterHelper.GetOperationMethodParameters(_method, _contextualPath),
9498
_convenienceMethod.Signature.Attributes,
9599
_convenienceMethod.Signature.GenericArguments,

eng/packages/http-client-csharp-mgmt/generator/TestProjects/Local/Mgmt-TypeSpec/src/Generated/BarCollection.cs

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

eng/packages/http-client-csharp-mgmt/generator/TestProjects/Local/Mgmt-TypeSpec/src/Generated/Extensions/MgmtTypeSpecExtensions.cs

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

eng/packages/http-client-csharp-mgmt/generator/TestProjects/Local/Mgmt-TypeSpec/src/Generated/Extensions/MockableMgmtTypeSpecSubscriptionResource.cs

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

eng/packages/http-client-csharp-mgmt/generator/TestProjects/Local/Mgmt-TypeSpec/src/Generated/FooCollection.cs

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

eng/packages/http-client-csharp-mgmt/generator/TestProjects/Local/Mgmt-TypeSpec/src/Generated/ZooCollection.cs

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

eng/packages/http-client-csharp-mgmt/generator/TestProjects/Local/Mgmt-TypeSpec/src/Generated/ZooResource.cs

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)