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

Minor bugfixes #859

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Minor bugfixes #859

wants to merge 5 commits into from

Conversation

dkfellows
Copy link
Member

Miscellaneous bits extracted from #857, mostly documentation tweaking to ensure that we always use the same active verb tense for brief descriptions of C functions.

It shouldn't change any real behaviour: the compiler can infer that the
pointer is non-NULL in all cases. Documenting that we do this is a good
plan anyway.
@dkfellows dkfellows added bug minor Not especially important. Might be cleanup activity, etc. labels Aug 12, 2020
@dkfellows dkfellows added this to the 6.0.0 milestone Aug 12, 2020
@@ -270,7 +270,7 @@ bool synapse_dynamics_initialise(

// Load timing dependence data
address_t weight_region_address = timing_initialise(address);
if (address == NULL) {
if (weight_region_address == NULL) {
Copy link
Member Author

Choose a reason for hiding this comment

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

This change was an absolute howler. Fortunately, I think the compiler was proving in all cases that the branch couldn't be taken, but it's still absurd.

@dkfellows dkfellows requested a review from rowleya August 12, 2020 11:29
@@ -907,7 +907,7 @@ USE_MDFILE_AS_MAINPAGE =
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.

SOURCE_BROWSER = NO
SOURCE_BROWSER = YES
Copy link
Member Author

Choose a reason for hiding this comment

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

Generates a link to the (pretty-printed) source for all files, not just headers.

//! \param[in] s: the spike to get the key from
//! \return key_t: the key from the spike
//! \return the key from the spike
static inline key_t spike_key(spike_t s) {
Copy link
Member Author

Choose a reason for hiding this comment

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

The key change I'm doing here is I'm trying to make it so that spike_key and spike_payload are only defined once; the differences are in the types they talk about and the body of the function. This makes the documentation process much nicer.

* spike is compiled as not having a pay load, the pay load will always be
* returned as 0
*/
#ifndef __SPIKE_T__
Copy link
Member Author

Choose a reason for hiding this comment

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

Don't need this. The file already has a guard and only this file defines the type of spikes.

@dkfellows dkfellows modified the milestones: 6.0.0, 7.0.0 Apr 12, 2021
@dkfellows dkfellows modified the milestones: 7.0.0, 7.1.0 Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug minor Not especially important. Might be cleanup activity, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant