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

Port test_pulsepacket_generator from SLI-2-Py #2815

Merged
merged 8 commits into from
Jun 28, 2023

Conversation

nicolossus
Copy link
Member

The PR also improves the formatting of the documentation for stimulation_device and pulsepacket_generator.

@nicolossus
Copy link
Member Author

nicolossus commented Jun 5, 2023

@jougs @jessica-mitchell The SLI-2-Py port is quite one-to-one and straightforward. However, in porting the test I noticed some places in the documentation that could be improved by some small changes to the formatting. As a general style for documenting parameters I suggest:

parameter
    Description, if applicable include [quantity] in [units]. Default: ``[default]``.

So far I have only made similar changes to the documentation on files I have touched, see #2813. I will make the corresponding changes elsewhere once we agree on the style.

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.

Just a minor change,
and more to @jougs the stimulation_device userdocs in nestkernel has a NOINDEX label, and I don't think it's in Read the docs. I think this should be included somewhere, oder?

nestkernel/stimulation_device.h Outdated Show resolved Hide resolved
Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
@heplesser heplesser removed the request for review from jougs June 28, 2023 08:09
@heplesser heplesser merged commit 379d507 into nest:master Jun 28, 2023
@nicolossus nicolossus deleted the port_test_pulsepacket_generator branch June 28, 2023 08:27
@terhorstd terhorstd 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 Sep 15, 2023
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
None yet
Development

Successfully merging this pull request may close these issues.

4 participants