Skip to content

Fix partial method doc comments#56419

Merged
RikkiGibson merged 8 commits intodotnet:mainfrom
RikkiGibson:partial-method-doc-comments
Sep 21, 2021
Merged

Fix partial method doc comments#56419
RikkiGibson merged 8 commits intodotnet:mainfrom
RikkiGibson:partial-method-doc-comments

Conversation

@RikkiGibson
Copy link
Copy Markdown
Member

@RikkiGibson RikkiGibson commented Sep 15, 2021

Fixes #54103.

The specific rule changes implemented in this PR are laid out in dotnet/csharplang#5193.

Have added tests to ensure that the expected documentation is shown in Quick Info.

@ghost ghost added the Area-Compilers label Sep 15, 2021
@RikkiGibson RikkiGibson marked this pull request as ready for review September 15, 2021 23:14
@RikkiGibson RikkiGibson requested review from a team as code owners September 15, 2021 23:14
@AlekseyTs

This comment has been minimized.

@AlekseyTs

This comment has been minimized.

Copy link
Copy Markdown
Contributor

@AlekseyTs AlekseyTs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM (commit 7)

@jcouv jcouv self-assigned this Sep 20, 2021
Copy link
Copy Markdown
Member

@jcouv jcouv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM Thanks (iteration 7)

@RikkiGibson
Copy link
Copy Markdown
Member Author

Do we need sign off from @dotnet/roslyn-ide for new tests in the IDE area?

@jcouv
Copy link
Copy Markdown
Member

jcouv commented Sep 21, 2021

Yes, we should get a review for the few added IDE tests.

@"partial class MyClass
{
///<summary>My Method Definition</summary>
public partial void MyMethod();
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add one more test where there is only an impl, but no def.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure thing.

@"partial class MyClass
{
///<summary>My Method Definition</summary>
public partial void MyMethod();
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any concern that all thse tests test the public case? i know ublic partials are different from nonpublic ones. would testing that be useful? or is all the same to the compiler?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or is all the same to the compiler?

I think it is, but I added one test where the partial method has no access modifiers for good measure.

@RikkiGibson RikkiGibson enabled auto-merge (squash) September 21, 2021 20:44
@RikkiGibson RikkiGibson merged commit 8cda746 into dotnet:main Sep 21, 2021
@ghost ghost added this to the Next milestone Sep 21, 2021
@RikkiGibson RikkiGibson deleted the partial-method-doc-comments branch September 22, 2021 03:46
@Cosifne Cosifne modified the milestones: Next, 17.0.P5 Sep 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CS1591: Redundant comments are required in all partial method definitions

5 participants