Skip to content

Update the C++ API location / URLs#836

Closed
MakisH wants to merge 2 commits intomasterfrom
MakisH-patch-4
Closed

Update the C++ API location / URLs#836
MakisH wants to merge 2 commits intomasterfrom
MakisH-patch-4

Conversation

@MakisH
Copy link
Member

@MakisH MakisH commented Mar 6, 2026

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:

  • As "location", links to the directory https://github.com/precice/precice/tree/main/src/precice, similarly to the C/Fortran bindings
  • Adds a link to "header" (precice.hpp)
  • Keeps the link to "API" (Participant.hpp)
  • Fixes the locations of the C/Fortran bindings to remove the GitHub URL parts from the locations

From a discussion with @dabele.

@fsimonis what do you think?

MakisH added 2 commits March 6, 2026 11:49
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.
@MakisH MakisH requested a review from fsimonis March 6, 2026 10:59
@MakisH MakisH self-assigned this Mar 6, 2026
@MakisH MakisH added the content Content-only issues label Mar 6, 2026
@fsimonis
Copy link
Member

fsimonis commented Mar 9, 2026

It still looks mixed to me.

Maybe the issue is the heading Location. If we change that to Repository, then it's clear what we mean and C++, C and Fortran would point to precice/precice.

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?

@MakisH
Copy link
Member Author

MakisH commented Mar 14, 2026

Right, I forgot that #718 was still open. I ported the changes there, which should cover all points.

@MakisH MakisH closed this Mar 14, 2026
@MakisH MakisH mentioned this pull request Mar 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Content-only issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants