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

Update class_maker.py #762

Merged
merged 6 commits into from May 20, 2015
Merged

Update class_maker.py #762

merged 6 commits into from May 20, 2015

Conversation

raquelalvarezbanos
Copy link
Contributor

Fixes #11754

This PR is to update the class_maker script to generate code following the current standards. Specifically there are three points to have a look at: clang format, naming convention and definitions in cpp files (see original trac ticket).

For tester:

I have updated class_maker.py according to clang format. To test, run the script (run with --h for help) to create a new class and check that it is formatted according to clang standards. Check the same for a new algorithm (run with --alg).

Regarding naming conventions and methods in header and source files (http://www.mantidproject.org/C%2B%2B_Coding_Standards), I have not modified or updated anything as the script was already generating code with the appropriate standards. Ensure this is correct (for instance, if a new algorithm is created there are some methods that must be overridden http://www.mantidproject.org/Algorithm_Documentation).

@raquelalvarezbanos raquelalvarezbanos added Tools Maintenance Unassigned issues to be addressed in the next maintenance period. labels May 18, 2015
@raquelalvarezbanos raquelalvarezbanos added this to the Release 3.5 milestone May 18, 2015
@DanNixon DanNixon self-assigned this May 19, 2015
@DanNixon
Copy link
Member

The only extra thing I can think that this could do with having is a note reminding the developer to subclass DataProcessorAlgorithm when the algorithm is a workflow algorithm.

@FedeMPouzols
Copy link
Contributor

Maybe another useful reminder could be added about processGroups() which you need to override when your algorithm operates on a WorkspaceGroup?

@raquelalvarezbanos
Copy link
Contributor Author

Thanks for the comments! the two reminders have been added, they are printed when class_maker is run with --alg.

@DanNixon
Copy link
Member

Looks good, I'll not bother waiting for the CI since this isn't included in it.

DanNixon added a commit that referenced this pull request May 20, 2015
@DanNixon DanNixon merged commit 6e7c980 into master May 20, 2015
@DanNixon DanNixon deleted the 11754_Update_class_maker branch May 20, 2015 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants