Skip to content

Document the API as “C++”, not “C”#89

Merged
Lightsaver7 merged 1 commit intoRedPitaya:masterfrom
edgar-bonet:cpp
Feb 12, 2026
Merged

Document the API as “C++”, not “C”#89
Lightsaver7 merged 1 commit intoRedPitaya:masterfrom
edgar-bonet:cpp

Conversation

@edgar-bonet
Copy link
Contributor

The Red Pitaya C API has been replaced by a C++ API. The February 2026 update to the documentation does mention this fact. However, there are still lots of pages that incorrectly mention a “C API”.

This pull request replaces “C” by “C++” in many places where this is relevant. Note however that:

  • it does not touch the many mentions of “C” within appsFeatures/examples, as I did not test these examples with a C++ compiler

  • it does not rename the files C_and_Python_API.{rst,inc}

Fixes: #87.

For the record, mentions of “C” can be found with the command below, but beware of the many false positives:

find . -name '*.rst' -o -name '*.inc' | sort | \
    xargs grep --color=always '\<C[^0-9A-Za-z_`:+]' | less -R

Many files still refer to the C language or API when they actually mean
C++. Fix them.
@Lightsaver7
Copy link
Collaborator

Oh, I see what you mean. Yes, I missed those during the update. I will merge this and check if there are any other places where this applies.

@Lightsaver7 Lightsaver7 merged commit 6638687 into RedPitaya:master Feb 12, 2026
@edgar-bonet edgar-bonet deleted the cpp branch February 12, 2026 11:47
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

Successfully merging this pull request may close these issues.

Please, document the removal of the C API

2 participants