From c3a38242e6ccb6953e78822427314f8d0094d592 Mon Sep 17 00:00:00 2001 From: SaintMalik <37118134+saintmalik@users.noreply.github.com> Date: Thu, 2 Sep 2021 16:38:45 +0100 Subject: Fix typos in docs (#6829) --- docs/source/CUsage.md | 2 +- docs/source/Internals.md | 4 ++-- docs/source/JavaScriptUsage.md | 2 +- docs/source/RustUsage.md | 2 +- docs/source/Schemas.md | 2 +- docs/source/Tutorial.md | 4 ++-- docs/source/TypeScriptUsage.md | 2 +- docs/source/WhitePaper.md | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) (limited to 'docs') diff --git a/docs/source/CUsage.md b/docs/source/CUsage.md index 9aafa6f7..bd1ec159 100644 --- a/docs/source/CUsage.md +++ b/docs/source/CUsage.md @@ -7,7 +7,7 @@ The `flatcc` C schema compiler can generate code offline as well as online via a C library. It can also generate buffer verifiers and fast JSON parsers, printers. -Great care has been taken to ensure compatibily with the main `flatc` +Great care has been taken to ensure compatibility with the main `flatc` project. ## General Documention diff --git a/docs/source/Internals.md b/docs/source/Internals.md index 16a16660..591f040c 100644 --- a/docs/source/Internals.md +++ b/docs/source/Internals.md @@ -85,7 +85,7 @@ referred to by offset. They start with an `soffset_t` to a vtable. This is a signed version of `uoffset_t`, since vtables may be stored anywhere relative to the object. -This offset is substracted (not added) from the object start to arrive at +This offset is subtracted (not added) from the object start to arrive at the vtable start. This offset is followed by all the fields as aligned scalars (or offsets). Unlike structs, not all fields need to be present. There is no set order and layout. A table may contain @@ -435,7 +435,7 @@ The keys vector is a typed vector of keys. Both the keys and corresponding values *have* to be stored in sorted order (as determined by `strcmp`), such that lookups can be made using binary search. -The reason the key vector is a seperate structure from the value vector is +The reason the key vector is a separate structure from the value vector is such that it can be shared between multiple value vectors, and also to allow it to be treated as its own individual vector in code. diff --git a/docs/source/JavaScriptUsage.md b/docs/source/JavaScriptUsage.md index 2f0d3793..64764e21 100644 --- a/docs/source/JavaScriptUsage.md +++ b/docs/source/JavaScriptUsage.md @@ -23,7 +23,7 @@ https://www.npmjs.com/package/flatbuffers. To use it from sources: 1. In your project, install it as a normal dependency, using the flatbuffers folder as the source. -## Using the FlatBuffers JavaScript libary +## Using the FlatBuffers JavaScript library *Note: See [Tutorial](@ref flatbuffers_guide_tutorial) for a more in-depth example of how to use FlatBuffers.* diff --git a/docs/source/RustUsage.md b/docs/source/RustUsage.md index 68191179..9e959a91 100644 --- a/docs/source/RustUsage.md +++ b/docs/source/RustUsage.md @@ -36,7 +36,7 @@ The test code itself is located in [integration_test.rs](https://github.com/google/flatbuffers/blob/master/tests/rust_usage_test/tests/integration_test.rs) This test file requires `flatc` to be present. To review how to build the project, -please read the [Building](@ref flatbuffers_guide_building) documenation. +please read the [Building](@ref flatbuffers_guide_building) documentation. To run the tests, execute `RustTest.sh` from the `flatbuffers/tests` directory. For example, on [Linux](https://en.wikipedia.org/wiki/Linux), you would simply diff --git a/docs/source/Schemas.md b/docs/source/Schemas.md index 3a2b15dd..10ed260c 100644 --- a/docs/source/Schemas.md +++ b/docs/source/Schemas.md @@ -490,7 +490,7 @@ as much as possible such that you can use tables where you might be tempted to use a dictionary. Similarly, strings as values should only be used when they are -truely open-ended. If you can, always use an enum instead. +truly open-ended. If you can, always use an enum instead. FlatBuffers doesn't have inheritance, so the way to represent a set of related data structures is a union. Unions do have a cost however, diff --git a/docs/source/Tutorial.md b/docs/source/Tutorial.md index c043cd23..cb77bed8 100644 --- a/docs/source/Tutorial.md +++ b/docs/source/Tutorial.md @@ -231,7 +231,7 @@ fields, such as `mana:short = 150`. If unspecified, scalar fields (like `int`, `uint`, or `float`) will be given a default of `0` while strings and tables will be given a default of `null`. Another thing to note is the line `friendly:bool = false (deprecated);`. Since you cannot delete fields from a `table` (to support -backwards compatability), you can set fields as `deprecated`, which will prevent +backwards compatibility), you can set fields as `deprecated`, which will prevent the generation of accessors for this field in the generated code. Be careful when using `deprecated`, however, as it may break legacy code that used this accessor. @@ -1090,7 +1090,7 @@ traversal. This is generally easy to do on any tree structures.
~~~{.py} - -- Serialize a name for our mosnter, called 'orc' + -- Serialize a name for our monster, called 'orc' local name = builder:CreateString("Orc") -- Create a `vector` representing the inventory of the Orc. Each number diff --git a/docs/source/TypeScriptUsage.md b/docs/source/TypeScriptUsage.md index 437b49d5..a1acaeb8 100644 --- a/docs/source/TypeScriptUsage.md +++ b/docs/source/TypeScriptUsage.md @@ -26,7 +26,7 @@ flatbuffers/blob/master/tests/TypeScriptTest.sh) shell script. *Note: The TypeScript test file requires [Node.js](https://nodejs.org/en/).* -## Using the FlatBuffers TypeScript libary +## Using the FlatBuffers TypeScript library *Note: See [Tutorial](@ref flatbuffers_guide_tutorial) for a more in-depth example of how to use FlatBuffers in TypeScript.* diff --git a/docs/source/WhitePaper.md b/docs/source/WhitePaper.md index e504ada4..af56b630 100644 --- a/docs/source/WhitePaper.md +++ b/docs/source/WhitePaper.md @@ -20,7 +20,7 @@ and locality. If it would be possible to do serialization with no temporary objects, no additional allocation, no copying, and good locality, this could be of great value. The reason serialization systems usually don't manage -this is because it goes counter to forwards/backwards compatability, and +this is because it goes counter to forwards/backwards compatibility, and platform specifics like endianness and alignment. FlatBuffers is what you get if you try anyway. -- cgit v1.2.3