Conversation
The "Location" of the C++ API currently links to `Participant.hpp`. This is the direct link to the API (so, easy for quick access), but it is not the header that we want people to include. This is a bit confusing. This PR changes the link to `src/precice/precice.hpp`. From a discussion with @dabele.
Member
|
It still looks mixed to me. Maybe the issue is the heading Instead of the actual location, we could point to the API docs instead. Not all bindings have a clear location, as they may contain out of multiple files and folders. Also doesn't this collide with #718? |
Member
Author
|
Right, I forgot that #718 was still open. I ported the changes there, which should cover all points. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The "Location" of the C++ API currently links to
Participant.hpp. This is the direct link to the API (so, easy for quick access), but it is not the header that we want people to include. This is a bit confusing.This PR:
precice.hpp)Participant.hpp)From a discussion with @dabele.
@fsimonis what do you think?