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

Revising comments on Event class #2538

Merged
merged 2 commits into from
Nov 29, 2022
Merged

Conversation

heplesser
Copy link
Contributor

This PR provides updated developer documentation for the Event class. It thus fixes #129. At a later stage, the Event class hierarchy should be reviewed fully.

@heplesser heplesser added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Nov 28, 2022
@heplesser heplesser added this to In progress in Documentation via automation Nov 28, 2022
Copy link
Contributor

@jessica-mitchell jessica-mitchell left a comment

Choose a reason for hiding this comment

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

@heplesser thanks for looking at this ancient issue; I just have some minor fixes from my side.

nestkernel/event.h Outdated Show resolved Hide resolved
nestkernel/event.h Outdated Show resolved Hide resolved
nestkernel/event.h Outdated Show resolved Hide resolved
nestkernel/event.h Outdated Show resolved Hide resolved
nestkernel/event.h Outdated Show resolved Hide resolved
nestkernel/event.h Outdated Show resolved Hide resolved
nestkernel/event.h Outdated Show resolved Hide resolved
nestkernel/event.h Outdated Show resolved Hide resolved
Documentation automation moved this from In progress to Review Nov 28, 2022
@med-ayssar
Copy link
Contributor

Looks good to me.

Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
@heplesser
Copy link
Contributor Author

@jessica-mitchell Thanks for your suggestions, I have accepted them all.

@heplesser
Copy link
Contributor Author

Since the test failure is due to causes entirely unrelated to this PR, I merge in spite of one failing test case.

@heplesser heplesser merged commit cca4bd7 into nest:master Nov 29, 2022
Documentation automation moved this from Review to Done Nov 29, 2022
@heplesser heplesser deleted the fix-129-event-doc branch December 19, 2022 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

Review role and use of Events in connection creation and signal transmission
3 participants