precice icon indicating copy to clipboard operation
precice copied to clipboard

Update API types

Open fsimonis opened this issue 2 years ago • 2 comments

Main changes of this PR

This PR updates the API types to the named types in types.hpp. This change is currently non-breaking.

Motivation and additional information

  1. Makes the API easier to read. #248
  2. Allows us to change the API types in a central locatation #887

Author's checklist

  • [ ] I added a changelog file with make changelog if there are user-observable changes since the last release.
  • [x] I ran make format to ensure everything is formatted correctly.
  • [x] I sticked to C++14 features.
  • [x] I sticked to CMake version 3.16.3.
  • [ ] I squashed / am about to squash all commits that should be seen as one.

Reviewers' checklist

  • [ ] Does the changelog entry make sense? Is it formatted correctly?
  • [ ] Do you understand the code changes?

fsimonis avatar Jun 14 '22 13:06 fsimonis

How does this change look like in our native bindings?

davidscn avatar Jun 14 '22 15:06 davidscn

This requires major updates in the documentation.

fsimonis avatar Jun 15 '22 08:06 fsimonis

This PR is now close to obsolete as most id types have been removed from the API.

The only one remaining is the VertexID type. Closing

fsimonis avatar May 06 '23 07:05 fsimonis