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

Add typedefs for return values #1323

Open
sandro-elsweijer opened this issue Dec 9, 2024 · 2 comments
Open

Add typedefs for return values #1323

sandro-elsweijer opened this issue Dec 9, 2024 · 2 comments
Labels
enhancement Enhances already existing code priority: low Should be solved eventually workload: medium Would take a week or less

Comments

@sandro-elsweijer
Copy link
Collaborator

We never defined what our return values mean and how they should look like.
Maybe we can add
typedef t8_success 1
typedef t8_failure 0
so that the return values of functions are defined and understandable

@sandro-elsweijer sandro-elsweijer added enhancement Enhances already existing code priority: low Should be solved eventually workload: medium Would take a week or less labels Dec 9, 2024
@sandro-elsweijer
Copy link
Collaborator Author

Maybe we can take a look at how sc does it

@sandro-elsweijer
Copy link
Collaborator Author

sandro-elsweijer commented Dec 9, 2024

Here is an example of two functions returning the exact opposite on success:

t8_forest_vtk_write_cells (t8_forest_t forest, FILE *vtufile, const int write_treeid, const int write_mpirank,

t8_write_pvtu (const char *filename, int num_procs, int write_tree, int write_rank, int write_level, int write_id,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhances already existing code priority: low Should be solved eventually workload: medium Would take a week or less
Projects
None yet
Development

No branches or pull requests

1 participant