aspire icon indicating copy to clipboard operation
aspire copied to clipboard

add XML docs to methods in the templates

Open boutquin opened this issue 1 year ago • 3 comments

Description

Added XML docs to methods in the templates; removed all warnings as well so the generated code compiles with TreatWarningsAsErrors set to true.

Fixes #4079

Checklist

  • Is this feature complete?
    • [X] Yes. Ready to ship.
    • [ ] No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • [ ] Yes
    • [X] No
  • Did you add public API?
    • [ ] Yes
      • If yes, did you have an API Review for it?
        • [ ] Yes
        • [ ] No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • [ ] Yes
        • [ ] No
    • [X] No
  • Does the change make any security assumptions or guarantees?
    • [ ] Yes
      • If yes, have you done a threat model and had a security review?
        • [ ] Yes
        • [ ] No
    • [X] No
  • Does the change require an update in our Aspire docs?
    • [ ] Yes
      • Link to aspire-docs issue:
    • [X] No
Microsoft Reviewers: Open in CodeFlow

boutquin avatar Aug 26 '24 01:08 boutquin

@dotnet-policy-service agree Sent from my iPad

On Aug 25, 2024, at 21:41, dotnet-policy-service[bot] @.***> wrote:

@dotnet-policy-service agree

boutquin avatar Aug 26 '24 04:08 boutquin

@DamianEdwards @eerhardt can you review?

davidfowl avatar Sep 15 '24 19:09 davidfowl

@boutquin are you still planning to work on this one?

DamianEdwards avatar Sep 30 '24 23:09 DamianEdwards

@boutquin are you still planning to work on this one?

@DamianEdwards Yes, got a bit busy with work--will resume work on this ASAP. Thanks for the gently nod! :)

boutquin avatar Oct 15 '24 04:10 boutquin

@boutquin thanks for the work. We'd welcome this change, but I'm going to close until you or someone else has time to continue work on it.

FYI snap for 9.1 is Feb 11.

danmoseley avatar Feb 02 '25 20:02 danmoseley