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

Headers content and include directory #462

Open
GiudGiud opened this issue Jun 15, 2020 · 0 comments
Open

Headers content and include directory #462

GiudGiud opened this issue Jun 15, 2020 · 0 comments

Comments

@GiudGiud
Copy link
Contributor

There's two main things that I believe we should change in how we use headers

  • the function definitions, docstrings, should go in the headers rather than the source .cpp files. That way whoever is looking at how to use a function does not have to look at its implementation.

  • the headers should be all together in an include directory. This would make it easier to find a source file or a header file, and also hides implementation for whoever is just looking to call OpenMOC from another code.

I'm posting this issue to see if there's any opposition or interest in doing this.

@GiudGiud GiudGiud changed the title Headers content and directory Headers content and include directory Jun 15, 2020
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