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

"Example" files are a fantastic idea but the naming is slightly confusing #130

Open
raacampbell opened this issue Sep 25, 2024 · 0 comments

Comments

@raacampbell
Copy link

This comment is associated with a openjournals/joss-reviews#7275.

It is an excellent idea to have the "Example" classes, as these allow users to construct programs using simulated hardware. They also can be used for unit testing downstream applications. The naming is a little confusing, though. I realise that probably the naming is related to the fact that these files are intended to be examples showing how to make a concrete class from an abstract class. However, all the classes you present here that inherit from an abstract class constitute a good example of how to perform this (assuming they are well documented).

I would therefore suggest renaming the "example" to "simulated" and integrate these into the example usage described in Issue #129. This would create more robust documentation and make it clearer what these classes can really achieve.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant