Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C#: Move signal documentation to the event #65823

Merged
merged 1 commit into from
Sep 15, 2022

Conversation

raulsntos
Copy link
Member

@raulsntos raulsntos commented Sep 15, 2022

Move signal documentation from the delegate to the event and also deprecate the event if the signal is deprecated.

Alternatively, we may want to keep the documentation in the delegate too.

Move signal documentation from the delegate to the event and also
deprecate the event if the signal is deprecated.
@raulsntos raulsntos added this to the 4.x milestone Sep 15, 2022
@raulsntos raulsntos requested a review from a team September 15, 2022 11:34
@neikeq
Copy link
Contributor

neikeq commented Sep 15, 2022

Alternatively, we may want to keep the documentation in the delegate too.

I suppose the delegate could specify which signal it's for, but I'm not sure what the convention is there.

@neikeq neikeq merged commit d39d462 into godotengine:master Sep 15, 2022
@raulsntos raulsntos deleted the dotnet/signal-docs branch September 15, 2022 16:56
@raulsntos
Copy link
Member Author

I'm not sure what the convention is either but it seems Microsoft usually documents these delegates as:

Represents the method that handles the {EventName} event of a {ClassName} class.

@raulsntos raulsntos modified the milestones: 4.x, 4.0 Sep 15, 2022
@neikeq
Copy link
Contributor

neikeq commented Sep 15, 2022

I'm not sure what the convention is either but it seems Microsoft usually documents these delegates as:

Represents the method that handles the {EventName} event of a {ClassName} class.

Where did you find this? All the events I find use the EventHandler delegate.

@raulsntos
Copy link
Member Author

I just randomly searched delegates that end with the EventHandler suffix in the BCL (using https://apisof.net/). A few examples:

@neikeq
Copy link
Contributor

neikeq commented Sep 15, 2022

Ah, I see. That's the convention I would follow then.

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.

2 participants