From 82b654935601796ac633fec947a61a7bc03b3671 Mon Sep 17 00:00:00 2001 From: Sibo Van Gool Date: Tue, 28 Jan 2025 18:18:37 +0100 Subject: [PATCH] [Docs] Correct small typos (#3165) --- docs/user-manual/framework/ground-interface.md | 2 +- docs/user-manual/overview/enum-arr-ser.md | 14 +++++++++----- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/user-manual/framework/ground-interface.md b/docs/user-manual/framework/ground-interface.md index 6aca395b93..85c642b605 100644 --- a/docs/user-manual/framework/ground-interface.md +++ b/docs/user-manual/framework/ground-interface.md @@ -38,7 +38,7 @@ constructs (e.g. radios, spacecraft buses). From the perspective of F´, the dri data and handle outgoing data. > [!NOTE] -> typically projects use a single driver to handle both input and output, however; two drivers may be used to if differing behavior is needed for uplink and downlink.(e.g. UDP downlink for speed and Tcp uplink reliability). +> typically projects use a single driver to handle both input and output, however; two drivers may be used too if differing behavior is needed for uplink and downlink.(e.g. UDP downlink for speed and Tcp uplink reliability). All drivers implement an input port receiving data from the framer. The driver should write input data to the hardware the driver manages. Drivers implement at least one of two methods to retrieve data from hardware: an input port diff --git a/docs/user-manual/overview/enum-arr-ser.md b/docs/user-manual/overview/enum-arr-ser.md index 0dfb020775..3f4ff34a2d 100644 --- a/docs/user-manual/overview/enum-arr-ser.md +++ b/docs/user-manual/overview/enum-arr-ser.md @@ -1,17 +1,21 @@ # Data Types and Data Structures: Primitive Types, Enums, Arrays, and Serializables This guide will describe the types available in F´. F´ defines both useful short names for primitive types as well as -a set of autocoded complex types. The types describe here are available to both the flight software and the ground +a set of autocoded complex types. The types described here are available to both the flight software and the ground system unless otherwise noted. Included in this document: -- [Primitive Types](#primitive-types) -- [Polymorphic Type](#polymorphic-type) -- [Complex Types](#complex-types) +- [Data Types and Data Structures: Primitive Types, Enums, Arrays, and Serializables](#data-types-and-data-structures-primitive-types-enums-arrays-and-serializables) + - [Primitive Types](#primitive-types) + - [Polymorphic Type](#polymorphic-type) + - [Setting Polymorphic Values](#setting-polymorphic-values) + - [Getting Polymorphic Values](#getting-polymorphic-values) + - [Checking Polymorphic Values](#checking-polymorphic-values) + - [Complex Types](#complex-types) - [Enums](#enums) - [Arrays](#arrays) - [Serializables](#serializables) - [C++ Classes](#c-classes) -- [Conclusion](#conclusion) + - [Conclusion](#conclusion) ## Primitive Types