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.

Sign up for GitHub

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

Fix typos/incorrect words in link docs #334

Merged
merged 2 commits into from
Aug 9, 2023
Merged

Fix typos/incorrect words in link docs #334

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
233421f
Fix typos/incorrect words
SprintKeyz May 6, 2023
659e5e1
fix link enum typos to correspond with pros source
SprintKeyz May 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions v5/api/cpp/link.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,14 @@ This function uses the following values of ``errno`` when an error state is reac
.. highlight:: cpp
::

#define LINK_RECIVER_PORT 1
#define LINK_RECEIVER_PORT 1

void opcontrol() {
pros::Link reciever(LINK_RECIVER_PORT);
pros::Link receiver(LINK_RECEIVER_PORT);

std::uint32_t recieveable_size = reciever.raw_receivable_size();
pros::lcd::set_text(1, "Link recieveable_size:");
pros::lcd::set_text(2, std::to_string(recieveable_size));
std::uint32_t receivable_size = receiver.raw_receivable_size();
pros::lcd::set_text(1, "Link receivable_size:");
pros::lcd::set_text(2, std::to_string(receivable_size));
}

**Returns:** PROS_ERR if port is not a link/radio, else the bytes available to be read by the user.
Expand Down Expand Up @@ -148,7 +148,7 @@ This function uses the following values of ``errno`` when an error state is reac
#define LINK_TRANSMITTER_PORT 1

void opcontrol() {
pros::Link transmitter(LINK_RECIVER_PORT);
pros::Link transmitter(LINK_TRANSMITTER_PORT);

std::uint32_t transmittable_size = transmitter.raw_transmittable_size();
pros::lcd::set_text(1, "Link transmittable_size:");
Expand Down Expand Up @@ -187,7 +187,7 @@ This function uses the following values of ``errno`` when an error state is reac
#define LINK_TRANSMITTER_PORT 1

void opcontrol() {
pros::Link transmitter(LINK_RECIVER_PORT);
pros::Link transmitter(LINK_TRANSMITTER_PORT);
char* data = "Hello!";

transmitter.transmit_raw((void*)data, sizeof(*data) * sizeof(data));
Expand Down Expand Up @@ -222,20 +222,20 @@ This function uses the following values of ``errno`` when an error state is reac
.. highlight:: cpp
::

std::uint32_t transmit_raw( void* data, std::uint16_t data_size )
std::uint32_t receive_raw( void* data, std::uint16_t data_size )

.. tab :: Example
.. highlight:: cpp
::

#define LINK_RECIVER_PORT 1
#define LINK_RECEIVER_PORT 1

void opcontrol() {
char* result;
char* expected = "Hello!";
pros::Link reciever(LINK_RECIVER_PORT);
pros::Link receiver(LINK_RECEIVER_PORT);

reciever.reciever_raw((void*)result, sizeof(*expected) * sizeof(expected));
receiver.receive_raw((void*)result, sizeof(*expected) * sizeof(expected));
}

============ =================================================================================================================
Expand Down Expand Up @@ -277,7 +277,7 @@ This function uses the following values of ``errno`` when an error state is reac
#define LINK_TRANSMITTER_PORT 1

void opcontrol() {
pros::Link transmitter(LINK_RECIVER_PORT);
pros::Link transmitter(LINK_TRANSMITTER_PORT);
char* data = "Hello!";

transmitter.transmit((void*)data, sizeof(*data) * sizeof(data));
Expand Down Expand Up @@ -319,14 +319,14 @@ This function uses the following values of ``errno`` when an error state is reac
.. highlight:: cpp
::

#define LINK_RECIVER_PORT 1
#define LINK_RECEIVER_PORT 1

void opcontrol() {
char* result;
char* expected = "Hello!";
pros::Link reciever(LINK_RECIVER_PORT);
pros::Link receiver(LINK_RECEIVER_PORT);

reciever.recieve((void*)result, sizeof(*expected) * sizeof(expected));
receiver.receive((void*)result, sizeof(*expected) * sizeof(expected));
}

============ =================================================================================================================
Expand Down Expand Up @@ -365,7 +365,7 @@ This function uses the following values of ``errno`` when an error state is reac
#define LINK_TRANSMITTER_PORT 1

void opcontrol() {
pros::Link transmitter(LINK_RECIVER_PORT);
pros::Link transmitter(LINK_TRANSMITTER_PORT);
char* data = "Hello!";

transmitter.transmit((void*)data, sizeof(*data) * sizeof(data));
Expand All @@ -383,17 +383,17 @@ Enumerated Values
::

typedef enum link_type_e {
E_LINK_RECIEVER = 0,
E_LINK_RECEIVER = 0,
E_LINK_TRANSMITTER,
E_LINK_RX = E_LINK_RECIEVER,
E_LINK_RX = E_LINK_RECEIVER,
E_LINK_TX = E_LINK_TRANSMITTER
} link_type_e_t;

============================= =============================================================
Value
============================= =============================================================
E_LINK_RECIEVER Indicating that the radio is a reciever.
E_LINK_RX Indicating that the radio is a reciever.
E_LINK_RECEIVER Indicating that the radio is a receiver.
E_LINK_RX Indicating that the radio is a receiver.
E_LINK_TRANSMITTER Indicating that the radio is a transmitter.
E_LINK_TX Indicating that the radio is a transmitter.
============================= =============================================================