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

Rename typedef variables in NEST #2215

Closed
pnbabu opened this issue Nov 22, 2021 · 3 comments
Closed

Rename typedef variables in NEST #2215

pnbabu opened this issue Nov 22, 2021 · 3 comments
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 stale Automatic marker for inactivity, please have another look here T: Maintenance Work to keep up the quality of the code and documentation.
Projects

Comments

@pnbabu
Copy link
Contributor

pnbabu commented Nov 22, 2021

The typedef variables present in nest_types.h should be renamed to names with an appropriate prefix or suffix.

Currently, NESTML synapse models cannot use a variable named delay to identify the dendritic delay because it conflicts with the NEST typedef of the same name. The typedefs could possibly be renamed with a suffix _t (but is generally not recommended as mentioned here) or with a prefix with nest_. Any suggestions?

@stinebuu stinebuu added this to To do (open issues) in Kernel via automation Dec 17, 2021
@stinebuu stinebuu added 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. labels Dec 17, 2021
@github-actions
Copy link

Issue automatically marked stale!

@github-actions github-actions bot added the stale Automatic marker for inactivity, please have another look here label Feb 16, 2022
@heplesser
Copy link
Contributor

We consciously decided not to use type-suffixes in NEST code. We will review the use of names such as delay for types.

Kernel automation moved this from To do (open issues) to Done (PRs and issues) Nov 25, 2022
@clinssen
Copy link
Contributor

Note that it would be a possibility to use namespaces to isolate the typedefs, e.g.

namespace nest_types {
    typedef std::vector< size_t > foobar;
}

void f(nest_types::foobar& x) {
   ...
}

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 stale Automatic marker for inactivity, please have another look here T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Kernel
  
Done
Development

No branches or pull requests

4 participants