docs: clean up whitespace and fix typo in tutorial.md (#8695)
* docs: remove trailing whitespace
* docs: fix typo in tutorial.md
diff --git a/Formatters.md b/Formatters.md
index 877c5f2..86ae501 100644
--- a/Formatters.md
+++ b/Formatters.md
@@ -19,4 +19,4 @@
## Typescript
-Typescript uses eslint as it's linter. Take a look at [how to install here](https://eslint.org/docs/user-guide/getting-started). Run the following command `eslint ts/** --ext .ts` in the root directory of the project
\ No newline at end of file
+Typescript uses eslint as it's linter. Take a look at [how to install here](https://eslint.org/docs/user-guide/getting-started). Run the following command `eslint ts/** --ext .ts` in the root directory of the project
diff --git a/README.md b/README.md
index ed3637a..41a5c44 100644
--- a/README.md
+++ b/README.md
@@ -34,7 +34,7 @@
```
./flatc --cpp --rust monster.fbs
```
-
+
Which generates `monster_generated.h` and `monster_generated.rs` files.
4. Serialize data
@@ -48,7 +48,7 @@
6. Read the data
Use the generated accessors to read the data from the serialized buffer.
-
+
It doesn't need to be the same language/schema version, FlatBuffers ensures the data is readable across languages and schema versions. See the [`Rust` example](https://github.com/google/flatbuffers/blob/master/samples/sample_binary.rs#L92-L106) reading the data written by `C++`.
## Documentation
diff --git a/benchmarks/swift/README.md b/benchmarks/swift/README.md
index 4f95872..d5ee2e8 100644
--- a/benchmarks/swift/README.md
+++ b/benchmarks/swift/README.md
@@ -6,4 +6,4 @@
or running them directly within terminal using:
-`swift package benchmark`
\ No newline at end of file
+`swift package benchmark`
diff --git a/docs/source/annotation.md b/docs/source/annotation.md
index 1e66eb6..cf40420 100644
--- a/docs/source/annotation.md
+++ b/docs/source/annotation.md
@@ -55,8 +55,8 @@
The prefix `+` is added to make searching for the offset (compared to some
random value) a bit easier.
-2. The raw binary data, expressed in hexadecimal format.
-
+2. The raw binary data, expressed in hexadecimal format.
+
This is in the little endian format the buffer uses internally and what you
would see with a normal binary text viewer.
@@ -108,7 +108,7 @@
### Binary Regions
-Binary regions are contiguous bytes regions that are grouped together to form
+Binary regions are contiguous bytes regions that are grouped together to form
some sort of value, e.g. a `scalar` or an array of scalars. A binary region may
be split up over multiple text lines, if the size of the region is large.
@@ -122,7 +122,7 @@
```
The first column (`+0x00A0`) is the offset to this region from the beginning of
-the buffer.
+the buffer.
The second column are the raw bytes (hexadecimal) that make up this region.
These are expressed in the little-endian format that flatbuffers uses for the
@@ -135,7 +135,7 @@
bytes are duplicated in this fashion since it is more intuitive to read the data
in the big-endian format (e.g., `0x0008`). This value is followed by the decimal
representation of the value (e.g., `(8)`). For strings, the raw string value is
-shown instead.
+shown instead.
The fifth column is a textual comment on what the value is. As much metadata as
known is provided.
@@ -146,4 +146,4 @@
`Offset32`), the fourth column also shows an `Loc: +0x025A` value which shows
where in the binary this region is pointing to. These values are absolute from
the beginning of the file, their calculation from the raw value in the 4th
-column depends on the context.
\ No newline at end of file
+column depends on the context.
diff --git a/docs/source/building.md b/docs/source/building.md
index 93c4d2b..e0f1d8a 100644
--- a/docs/source/building.md
+++ b/docs/source/building.md
@@ -152,11 +152,11 @@
# The flatbuffers target carry header search path automatically if CMake > 2.8.11.
target_link_libraries(own_project_target PRIVATE flatbuffers)
```
-When build your project the `flatbuffers` library will be compiled and linked
+When build your project the `flatbuffers` library will be compiled and linked
to a target as part of your project.
#### Override default depth limit of nested objects
-To override [the depth limit of recursion](languages/cpp.md),
+To override [the depth limit of recursion](languages/cpp.md),
add this directive:
```cmake
set(FLATBUFFERS_MAX_PARSING_DEPTH 16)
@@ -174,4 +174,4 @@
```shell
$ slsa-verifier -artifact-path <downloaded.zip> -provenance attestation.intoto.jsonl -source github.com/google/flatbuffers -tag <version>
PASSED: Verified SLSA provenance
-```
\ No newline at end of file
+```
diff --git a/docs/source/contributing.md b/docs/source/contributing.md
index a65b60a..147e886 100644
--- a/docs/source/contributing.md
+++ b/docs/source/contributing.md
@@ -15,17 +15,17 @@
Before we can use your contributions, you __must__ sign one of the following license agreements. The agreements are self-served at the following links.
Our code review process will automatically check if you have signed the CLA, so
-don't fret. Though it may be prudent to check before spending a lot of time on
+don't fret. Though it may be prudent to check before spending a lot of time on
contribution.
-### Individual Contributions
+### Individual Contributions
For individuals, the [Google Individual
Contributor License Agreement
(CLA)](https://cla.developers.google.com/about/google-individual?csw=1) which is
self served at the link. The CLA is required since you own the copyright to your
changes, even after your contribution becomes part of our codebase, so we need
-your permission to use and distribute your code.
+your permission to use and distribute your code.
### Corporate Contributions
@@ -67,7 +67,7 @@
pip install mkdocs-redirects
```
-Then, in the `root` directory of flatbuffers, run
+Then, in the `root` directory of flatbuffers, run
```
mkdocs serve -f docs/mkdocs.yml
@@ -77,4 +77,4 @@
the rendered pages locally.
Submit your documentation changes with your code changes and they will
-automatically get published when your code is submitted.
\ No newline at end of file
+automatically get published when your code is submitted.
diff --git a/docs/source/evolution.md b/docs/source/evolution.md
index 0f22cac..b1eb5d4 100644
--- a/docs/source/evolution.md
+++ b/docs/source/evolution.md
@@ -261,7 +261,7 @@
```sh
--conform FILE
-```
+```
Where `FILE` is the base schema the rest of the input schemas must evolve from.
It returns `0` if they are properly evolved, otherwise returns a non-zero value
diff --git a/docs/source/flatc.md b/docs/source/flatc.md
index 5ef6b4e..be6d8f1 100644
--- a/docs/source/flatc.md
+++ b/docs/source/flatc.md
@@ -1,13 +1,13 @@
# FlatBuffers Compiler (`flatc`)
The main compiler for FlatBuffers is called `flatc` and is used to convert
-schema definitions into generated code files for a variety of languages.
+schema definitions into generated code files for a variety of languages.
After [building](building.md) `flatc`, it is used as follows:
```sh
-flatc [ GENERATOR_OPTIONS ] [ -o PATH ] [- I PATH ]
- FILES...
+flatc [ GENERATOR_OPTIONS ] [ -o PATH ] [- I PATH ]
+ FILES...
[ -- BINARY_FILES... ]
```
@@ -65,17 +65,17 @@
=== "To Binary"
To serialize the JSON data in `mydata.json` using the schema `myschema.fbs`:
-
+
```sh
flatc --binary myschema.fbs mydata.json
```
- This will generate a `mydata_wire.bin` file containing the serialized
+ This will generate a `mydata_wire.bin` file containing the serialized
flatbuffer data.
=== "To JSON"
- To convert the serialized binary flatbuffer `mydata.bin` using the schema
+ To convert the serialized binary flatbuffer `mydata.bin` using the schema
`myschema.fbs` to JSON:
```sh
diff --git a/docs/source/intermediate_representation.md b/docs/source/intermediate_representation.md
index f4eb075..4997e7a 100644
--- a/docs/source/intermediate_representation.md
+++ b/docs/source/intermediate_representation.md
@@ -6,7 +6,7 @@
Since this IR is a Flatbuffer, you can load and use it at runtime for runtime
reflection purposes.
-There are some quirks:
+There are some quirks:
- Tables and Structs are serialized as `Object`s.
- Unions and Enums are serialized as `Enum`s.
- It is the responsibility of the code generator to check the `advanced_features`
@@ -18,7 +18,7 @@
inferred to be the directory containing the first provided schema file.
-## Invocation
+## Invocation
You can invoke it like so
```{.sh}
flatc -b --schema ${your_fbs_files}
diff --git a/docs/source/languages/dart.md b/docs/source/languages/dart.md
index ca370c7..b3fc9ad 100644
--- a/docs/source/languages/dart.md
+++ b/docs/source/languages/dart.md
@@ -93,7 +93,7 @@
goal of this implementation. Support for 16 bit integers was also added.
5. The code generation in this offers an "ObjectBuilder", which generates code
very similar to the SDK classes that consume FlatBuffers, as well as Builder
- classes, which produces code which more closely resembles the builders in
+ classes, which produces code which more closely resembles the builders in
other languages. The ObjectBuilder classes are easier to use, at the cost of
additional references allocated.
diff --git a/docs/source/languages/javascript.md b/docs/source/languages/javascript.md
index d75442d..4d41c8f 100644
--- a/docs/source/languages/javascript.md
+++ b/docs/source/languages/javascript.md
@@ -16,7 +16,7 @@
## FlatBuffers JavaScript library code location
-The generated code for the FlatBuffers JavaScript library can be found at
+The generated code for the FlatBuffers JavaScript library can be found at
https://www.npmjs.com/package/flatbuffers. To use it from sources:
1. Run `npm run compile` from the main folder to generate JS files from TS.
@@ -36,7 +36,7 @@
running with JS are:
1. Generate TS files from `*.fbs` by using the `--ts` option.
-1. Transpile resulting TS files to desired JS flavor using `tsc` (see
+1. Transpile resulting TS files to desired JS flavor using `tsc` (see
https://www.typescriptlang.org/download for installation instructions).
~~~{.js}
diff --git a/docs/source/languages/kotlin.md b/docs/source/languages/kotlin.md
index 43e7eaa..58f048e 100644
--- a/docs/source/languages/kotlin.md
+++ b/docs/source/languages/kotlin.md
@@ -81,4 +81,4 @@
The most obvious ones are:
* Fields as accessed as Kotlin [properties](https://kotlinlang.org/docs/reference/properties.html)
-* Static methods are accessed in [companion object](https://kotlinlang.org/docs/reference/classes.html#companion-objects)
\ No newline at end of file
+* Static methods are accessed in [companion object](https://kotlinlang.org/docs/reference/classes.html#companion-objects)
diff --git a/docs/source/languages/lua.md b/docs/source/languages/lua.md
index 6843d46..0e97b4c 100644
--- a/docs/source/languages/lua.md
+++ b/docs/source/languages/lua.md
@@ -50,7 +50,7 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.lua}
-- require the library
local flatbuffers = require("flatbuffers")
-
+
-- require the generated code
local monster = require("MyGame.Sample.Monster")
diff --git a/docs/source/languages/swift.md b/docs/source/languages/swift.md
index 78046c0..a148d87 100644
--- a/docs/source/languages/swift.md
+++ b/docs/source/languages/swift.md
@@ -81,7 +81,7 @@
fatalError("couldn't mutate")
}
// mutate a struct field using flatbuffers struct
- // DONT use monster.pos to mutate since swift copy on write
+ // DONT use monster.pos to mutate since swift copy on write
// will not mutate the value in the buffer
let vec = monster.mutablePos.mutate(z: 4)
diff --git a/docs/source/quick_start.md b/docs/source/quick_start.md
index 2f642f3..34cb93a 100644
--- a/docs/source/quick_start.md
+++ b/docs/source/quick_start.md
@@ -44,11 +44,11 @@
#include "flatbuffers.h"
#include "monster_generated.h"
- int main() {
+ int main() {
// Used to build the flatbuffer
FlatBufferBuilder builder;
- // Auto-generated function emitted from `flatc` and the input
+ // Auto-generated function emitted from `flatc` and the input
// `monster.fbs` schema.
auto monster = CreateMonsterDirect(builder, "Abominable Snowman", 100);
@@ -60,7 +60,7 @@
See complete [C++ Example](https://github.com/google/flatbuffers/blob/master/samples/sample_binary.cpp#L24-L56).
5. **Transmit/Store the serialized FlatBuffer**
-
+
Use your serialized buffer however you want. Send it to someone, save if for
later, etc...
@@ -73,10 +73,10 @@
Use the generated accessors to read the data from the serialized buffer.
- It doesn't need to be the same language, or even schema version (see
+ It doesn't need to be the same language, or even schema version (see
[Evolving](evolution.md)), FlatBuffers ensures the data is readable across
- languages and schema versions.
-
+ languages and schema versions.
+
```c++ title="my_monster_factory.cc" linenums="15"
// Get a view of the root monster from the flatbuffer.
const Monster snowman = GetMonster(flatbuffer);
@@ -84,7 +84,7 @@
// Access the monster's fields directly.
ASSERT_EQ(snowman->name(), "Abominable Snowman");
ASSERT_EQ(snowman->health(), 100);
- ```
-
+ ```
+
See [`Rust` examples](https://github.com/google/flatbuffers/blob/master/samples/sample_binary.rs#L92-L106)
for reading the data written by `C++`.
diff --git a/docs/source/tutorial.md b/docs/source/tutorial.md
index e43e136..58699b3 100644
--- a/docs/source/tutorial.md
+++ b/docs/source/tutorial.md
@@ -165,11 +165,11 @@
=== "C"
- !!! Note
+ !!! Note
- If you're working in C, you need to use the separate project
- [FlatCC](https://github.com/dvidelabs/flatcc) which contains a schema
- compiler and runtime library in C for C. See
+ If you're working in C, you need to use the separate project
+ [FlatCC](https://github.com/dvidelabs/flatcc) which contains a schema
+ compiler and runtime library in C for C. See
[flatcc build instructions](https://github.com/dvidelabs/flatcc#building).
Please be aware of the difference between `flatc` and `flatcc` tools.
@@ -291,7 +291,7 @@
// Convenient namespace macro to manage long namespace prefix.
#undef ns
// Specified in the schema.
- #define ns(x) FLATBUFFERS_WRAP_NAMESPACE(MyGame_Sample, x)
+ #define ns(x) FLATBUFFERS_WRAP_NAMESPACE(MyGame_Sample, x)
// A helper to simplify creating vectors from C-arrays.
#define c_vec_len(V) (sizeof(V)/sizeof((V)[0]))
@@ -333,14 +333,14 @@
=== "JavaScript"
```javascript
- // The following code is an example - use your desired module flavor by
- // transpiling from TS.
+ // The following code is an example - use your desired module flavor by
+ // transpiling from TS.
var flatbuffers = require('/js/flatbuffers').flatbuffers;
var MyGame = require('./monster_generated').MyGame; // Generated by `flatc`.
//------------------------------------------------------------------------//
- // The following code is for browser-based HTML/JavaScript. Use the above
+ // The following code is for browser-based HTML/JavaScript. Use the above
// code for JavaScript module loaders (e.g. Node.js).
<script src="../js/flatbuffers.js"></script>
<script src="monster_generated.js"></script> // Generated by `flatc`.
@@ -384,12 +384,12 @@
// The last segment of the class name matches the file name.
$class = substr($class_name, strrpos($class_name, "\\") + 1);
// `flatbuffers` root.
- $root_dir = join(DIRECTORY_SEPARATOR, array(dirname(dirname(__FILE__))));
+ $root_dir = join(DIRECTORY_SEPARATOR, array(dirname(dirname(__FILE__))));
// Contains the `*.php` files for the FlatBuffers library and the `flatc`
// generated files.
$paths = array(join(DIRECTORY_SEPARATOR, array($root_dir, "php")),
- join(DIRECTORY_SEPARATOR,
+ join(DIRECTORY_SEPARATOR,
array($root_dir, "samples", "MyGame", "Sample")));
foreach ($paths as $path) {
$file = join(DIRECTORY_SEPARATOR, array($path, $class . ".php"));
@@ -546,7 +546,7 @@
=== "Lobster"
```lobster
- // Construct a Builder with 1024 byte backing array.
+ // Construct a Builder with 1024 byte backing array.
let builder = flatbuffers_builder {}
```
@@ -630,9 +630,9 @@
=== "C"
```c
- flatbuffers_string_ref_t weapon_one_name
+ flatbuffers_string_ref_t weapon_one_name
= flatbuffers_string_create_str(B, "Sword");
- flatbuffers_string_ref_t weapon_two_name
+ flatbuffers_string_ref_t weapon_two_name
= flatbuffers_string_create_str(B, "Axe");
```
@@ -722,7 +722,7 @@
=== "TypeScript"
- ```ts
+ ```ts
let weaponOne = builder.createString('Sword');
let weaponTwo = builder.createString('Axe');
```
@@ -760,9 +760,9 @@
uint16_t weapon_one_damage = 3;
uint16_t weapon_two_damage = 5;
- ns(Weapon_ref_t) sword
+ ns(Weapon_ref_t) sword
= ns(Weapon_create(B, weapon_one_name, weapon_one_damage));
- ns(Weapon_ref_t) axe
+ ns(Weapon_ref_t) axe
= ns(Weapon_create(B, weapon_two_name, weapon_two_damage));
```
@@ -772,7 +772,7 @@
short weaponOneDamage = 3;
short weaponTwoDamage = 5;
- // Use the `CreateWeapon()` helper function to create the weapons, since we
+ // Use the `CreateWeapon()` helper function to create the weapons, since we
// set every field.
Offset<Weapon> sword =
Weapon.CreateWeapon(builder, weaponOneName, weaponOneDamage);
@@ -1073,7 +1073,7 @@
=== "Java"
```java
- // Place the two weapons into an array, and pass it to the
+ // Place the two weapons into an array, and pass it to the
// `createWeaponsVector()` method to create a FlatBuffer vector.
int[] weaps = new int[2];
weaps[0] = sword;
@@ -1096,7 +1096,7 @@
=== "Kotlin"
```kotlin
- // Place the two weapons into an array, and pass it to the
+ // Place the two weapons into an array, and pass it to the
// `createWeaponsVector()` method to create a FlatBuffer vector.
val weaps = intArrayOf(sword, axe)
@@ -1537,7 +1537,7 @@
```java
// Serialize a name for our monster, called "Orc".
int name = builder.createString("Orc");
-
+
// Create our monster using `startMonster()` and `endMonster()`.
Monster.startMonster(builder);
Monster.addPos(builder, Vec3.createVec3(builder, 1.0f, 2.0f, 3.0f));
@@ -1567,7 +1567,7 @@
MyGame.Sample.Monster.addName(builder, name);
MyGame.Sample.Monster.addInventory(builder, inv);
MyGame.Sample.Monster.addWeapons(builder, weapons);
- MyGame.Sample.Monster.addEquippedType(builder,
+ MyGame.Sample.Monster.addEquippedType(builder,
MyGame.Sample.Equipment.Weapon);
MyGame.Sample.Monster.addEquipped(builder, axe);
MyGame.Sample.Monster.addPath(builder, path);
@@ -1649,7 +1649,7 @@
\MyGame\Sample\Monster::AddInventory($builder, $inv);
\MyGame\Sample\Monster::AddColor($builder, \MyGame\Sample\Color::Red);
\MyGame\Sample\Monster::AddWeapons($builder, $weapons);
- \MyGame\Sample\Monster::AddEquippedType($builder,
+ \MyGame\Sample\Monster::AddEquippedType($builder,
\MyGame\Sample\Equipment::Weapon);
\MyGame\Sample\Monster::AddEquipped($builder, $axe);
\MyGame\Sample\Monster::AddPath($builder, $path);
@@ -1782,7 +1782,7 @@
```dart
// Call `finish()` to instruct the builder that this monster is complete.
- // See the next code section, as in Dart `finish` will also return the byte
+ // See the next code section, as in Dart `finish` will also return the byte
// array.
```
@@ -1982,7 +1982,7 @@
```php
// This must be called after `finish()`.
$buf = $builder->dataBuffer(); // Of type `Google\FlatBuffers\ByteBuffer`
- // The data in this ByteBuffer does NOT start at 0, but at
+ // The data in this ByteBuffer does NOT start at 0, but at
// buf->getPosition().
// The end of the data is marked by buf->capacity(), so the size is
// buf->capacity() - buf->getPosition().
@@ -2056,7 +2056,7 @@
```c++
uint8_t *buffer_pointer = /* the data you just read */;
- // Get an view to the root object inside the buffer.
+ // Get a view to the root object inside the buffer.
Monster monster = GetMonster(buffer_pointer);
```
@@ -2076,7 +2076,7 @@
```c#
byte[] bytes = /* the data you just read */
- // Get an view to the root object inside the buffer.
+ // Get a view to the root object inside the buffer.
Monster monster = Monster.GetRootAsMonster(new ByteBuffer(bytes));
```
@@ -2204,7 +2204,7 @@
```ts
// the data you just read, as a `Uint8Array`.
- // Note that the example here uses `readFileSync` from the built-in `fs`
+ // Note that the example here uses `readFileSync` from the built-in `fs`
// module, but other methods for accessing the file contents will also work.
let bytes = new Uint8Array(readFileSync('./monsterdata.bin'));
@@ -2656,9 +2656,9 @@
ns(Weapon_vec_t) weapons = ns(Monster_weapons(monster));
size_t weapons_len = ns(Weapon_vec_len(weapons));
// We can use `const char *` instead of `flatbuffers_string_t`.
- const char *second_weapon_name =
+ const char *second_weapon_name =
ns(Weapon_name(ns(Weapon_vec_at(weapons, 1))));
- uint16_t second_weapon_damage =
+ uint16_t second_weapon_damage =
ns(Weapon_damage(ns(Weapon_vec_at(weapons, 1))));
```
@@ -2791,11 +2791,11 @@
```c++
auto union_type = monster.equipped_type();
-
+
if (union_type == Equipment_Weapon) {
// Requires `static_cast` to type `const Weapon*`.
auto weapon = static_cast<const Weapon*>(monster->equipped());
-
+
auto weapon_name = weapon->name()->str(); // "Axe"
auto weapon_damage = weapon->damage(); // 5
}
@@ -2807,7 +2807,7 @@
// Access union type field.
if (ns(Monster_equipped_type(monster)) == ns(Equipment_Weapon)) {
// Cast to appropriate type:
- // C allows for silent void pointer assignment, so we need no
+ // C allows for silent void pointer assignment, so we need no
// explicit cast.
ns(Weapon_table_t) weapon = ns(Monster_equipped(monster));
const char *weapon_name = ns(Weapon_name(weapon)); // "Axe"
@@ -2819,10 +2819,10 @@
```c#
var unionType = monster.EquippedType;
-
+
if (unionType == Equipment.Weapon) {
var weapon = monster.Equipped<Weapon>().Value;
-
+
var weaponName = weapon.Name; // "Axe"
var weaponDamage = weapon.Damage; // 5
}
@@ -2852,7 +2852,7 @@
unionType := monster.EquippedType()
if unionType == sample.EquipmentWeapon {
- // Create a `sample.Weapon` object that can be initialized with the
+ // Create a `sample.Weapon` object that can be initialized with the
// contents of the `flatbuffers.Table` (`unionTable`), which was
// populated by `monster.Equipped()`.
unionWeapon = new(sample.Weapon)
@@ -2887,7 +2887,7 @@
// 'Axe'
var weaponName = monster.equipped(new MyGame.Sample.Weapon()).name();
// 5
- var weaponDamage =
+ var weaponDamage =
monster.equipped(new MyGame.Sample.Weapon()).damage();
}
```
@@ -2912,8 +2912,8 @@
union_type = monster.equipped_type
if union_type == MyGame_Sample_Equipment_Weapon:
- // `monster.equipped_as_Weapon` returns a FlatBuffer handle much like
- // normal table fields, but this is only valid to call if we already
+ // `monster.equipped_as_Weapon` returns a FlatBuffer handle much like
+ // normal table fields, but this is only valid to call if we already
// know it is the correct type.
let union_weapon = monster.equipped_as_Weapon
@@ -2945,8 +2945,8 @@
$weapon_name =
$monster->getEquipped(new \MyGame\Sample\Weapon())->getName();
// 5
- $weapon_damage =
- $monster->getEquipped(new \MyGame\Sample\Weapon())->getDamage();
+ $weapon_damage =
+ $monster->getEquipped(new \MyGame\Sample\Weapon())->getDamage();
}
```
@@ -2996,8 +2996,8 @@
if (unionType == MyGame.Sample.Equipment.Weapon) {
// 'Axe'
- let weaponName = monster.equipped(new MyGame.Sample.Weapon()).name();
- // 5
+ let weaponName = monster.equipped(new MyGame.Sample.Weapon()).name();
+ // 5
let weaponDamage = monster.equipped(new MyGame.Sample.Weapon()).damage();
}
```
diff --git a/goldens/README.md b/goldens/README.md
index 856c0ef..6ae6014 100644
--- a/goldens/README.md
+++ b/goldens/README.md
@@ -18,7 +18,7 @@
Some languages may not support every generation feature, so each language is
required to specify the `flatc` arguments individually.
-* Try to avoid includes and nested directories, preferring it as flat as
+* Try to avoid includes and nested directories, preferring it as flat as
possible.
## Updating
diff --git a/grpc/examples/README.md b/grpc/examples/README.md
index c821218..1b4c21c 100644
--- a/grpc/examples/README.md
+++ b/grpc/examples/README.md
@@ -32,4 +32,4 @@
- Always requires the `content-type` of the payload to be set to `application/grpc+flatbuffers`
-example: `.SayHello(ctx, b, grpc.CallContentSubtype("flatbuffers"))`
\ No newline at end of file
+example: `.SayHello(ctx, b, grpc.CallContentSubtype("flatbuffers"))`
diff --git a/grpc/examples/go/greeter/README.md b/grpc/examples/go/greeter/README.md
index 3390508..9be712e 100644
--- a/grpc/examples/go/greeter/README.md
+++ b/grpc/examples/go/greeter/README.md
@@ -22,4 +22,4 @@
- `go clean`
-- `go run main.go --name NAME`
\ No newline at end of file
+- `go run main.go --name NAME`
diff --git a/grpc/examples/python/greeter/README.md b/grpc/examples/python/greeter/README.md
index fcf310c..9620e9c 100644
--- a/grpc/examples/python/greeter/README.md
+++ b/grpc/examples/python/greeter/README.md
@@ -9,4 +9,4 @@
## How to run Client:
-- `python client.py ${PORT} ${NAME}`
\ No newline at end of file
+- `python client.py ${PORT} ${NAME}`
diff --git a/grpc/examples/ts/greeter/README.md b/grpc/examples/ts/greeter/README.md
index 5c7b380..d82c081 100644
--- a/grpc/examples/ts/greeter/README.md
+++ b/grpc/examples/ts/greeter/README.md
@@ -10,4 +10,4 @@
## How to run Client:
-- `npm run client 3000`
\ No newline at end of file
+- `npm run client 3000`
diff --git a/js/README.md b/js/README.md
index cbcebe0..2ce48ef 100644
--- a/js/README.md
+++ b/js/README.md
@@ -1 +1 @@
-This folder is intentionally empty and will contain transpiled js modules in Common JS format after compiling with tsc.
\ No newline at end of file
+This folder is intentionally empty and will contain transpiled js modules in Common JS format after compiling with tsc.
diff --git a/mjs/README.md b/mjs/README.md
index e3ca9db..0092006 100644
--- a/mjs/README.md
+++ b/mjs/README.md
@@ -1 +1 @@
-This folder is intentionally empty and will contain transpiled js modules in ES modules format after compiling with tsc.
\ No newline at end of file
+This folder is intentionally empty and will contain transpiled js modules in ES modules format after compiling with tsc.
diff --git a/swift/README.md b/swift/README.md
index cbacbf4..201ee11 100644
--- a/swift/README.md
+++ b/swift/README.md
@@ -8,4 +8,4 @@
### Contribute
-1- Always run `swift test --generate-linuxmain` whenever new test functions are added or removed
\ No newline at end of file
+1- Always run `swift test --generate-linuxmain` whenever new test functions are added or removed
diff --git a/tests/annotated_binary/README.md b/tests/annotated_binary/README.md
index 0cb0461..d0d942b 100644
--- a/tests/annotated_binary/README.md
+++ b/tests/annotated_binary/README.md
@@ -1,6 +1,6 @@
# Annotated Flatbuffer Binary
-This directory demonstrates the ability of flatc to annotate binary flatbuffers
+This directory demonstrates the ability of flatc to annotate binary flatbuffers
with helpful annotations. The resulting annotated flatbuffer binary (afb)
contains all the binary data with line-by-line annotations.
@@ -33,7 +33,7 @@
Currently there is a built-in text-based format for outputting the annotations.
The `annotated_binary.afb` is an example of the text format of a binary
-`annotated_binary.bin` and the `annotated_binary.fbs` (or
+`annotated_binary.bin` and the `annotated_binary.fbs` (or
`annotated_binary.bfbs`) schema.
The file is ordered in increasing the offsets from the beginning of the binary.
@@ -41,9 +41,9 @@
### Binary Sections
-Binary sections are comprised of contigious [binary regions](#binary-regions)
+Binary sections are comprised of contigious [binary regions](#binary-regions)
that are logically grouped together. For example, a binary section may be a
-single instance of a flatbuffer `Table` or its `vtable`. The sections may be
+single instance of a flatbuffer `Table` or its `vtable`. The sections may be
labelled with the name of the associated type, as defined in the input schema.
Example of a `vtable` Binary Section that is associated with the user-defined
@@ -59,7 +59,7 @@
### Binary Regions
-Binary regions are contigious bytes regions that are grouped together to form
+Binary regions are contigious bytes regions that are grouped together to form
some sort of value, e.g. a `scalar` or an array of scalars. A binary region may
be split up over multiple text lines, if the size of the region is large.
@@ -71,10 +71,10 @@
```
The first column (`+0x00A0`) is the offset to this region from the beginning of
-the buffer.
+the buffer.
The second column are the raw bytes (hexadecimal) that make up this
-region. These are expressed in the little-endian format that flatbuffers uses
+region. These are expressed in the little-endian format that flatbuffers uses
for the wire format.
The third column is the type to interpret the bytes as. Some types are special
@@ -87,15 +87,15 @@
bytes are duplicated in this fashion since it is more intutive to read the data
in the big-endian format (e.g., `0x0008`). This value is followed by the decimal
representation of the value (e.g., `(8)`). (For strings, the raw string value
-is shown instead).
+is shown instead).
The fifth column is a textual comment on what the value is. As much metadata as
known is provided.
#### Offsets
-If the type in the 3rd column is of an absolute offset (`SOffet32` or
-`Offset32`), the fourth column also shows an `Loc: +0x025A` value which shows
+If the type in the 3rd column is of an absolute offset (`SOffet32` or
+`Offset32`), the fourth column also shows an `Loc: +0x025A` value which shows
where in the binary this region is pointing to. These values are absolute from
the beginning of the file, their calculation from the raw value in the 4th
column depends on the context.
diff --git a/tests/annotated_binary/tests/README.md b/tests/annotated_binary/tests/README.md
index c0d73f4..f15a0be 100644
--- a/tests/annotated_binary/tests/README.md
+++ b/tests/annotated_binary/tests/README.md
@@ -50,7 +50,7 @@
### `invalid_vtable_ref_table_size_short.bin`
-Changed two bytes at 0x000C from `6800` to `0100` which size is smaller than
+Changed two bytes at 0x000C from `6800` to `0100` which size is smaller than
the minimum size of 4 bytes.
### `invalid_vtable_field_offset.bin`
@@ -70,7 +70,7 @@
### `invalid_string_length_cut_short.bin`
-Truncated the file to 0xAD bytes, as that cuts string length Uint32t value in
+Truncated the file to 0xAD bytes, as that cuts string length Uint32t value in
half.
### `invalid_string_length.bin`
@@ -80,7 +80,7 @@
### `invalid_vector_length_cut_short.bin`
-Truncated the file to 0x0136 bytes, as that cuts vector length Uint32t value in
+Truncated the file to 0x0136 bytes, as that cuts vector length Uint32t value in
half.
### `invalid_struct_field_cut_short.bin`
@@ -106,12 +106,12 @@
### `invalid_vector_scalars_cut_short.bin`
-Truncated the file to 0x01C1 bytes, as that cuts into a vector of scalars
+Truncated the file to 0x01C1 bytes, as that cuts into a vector of scalars
values.
### `invalid_vector_unions_cut_short.bin`
-Truncated the file to 0x01DE bytes, as that cuts into a vector of union offset
+Truncated the file to 0x01DE bytes, as that cuts into a vector of union offset
values.
### `invalid_union_type_value.bin`
@@ -121,5 +121,5 @@
### `invalid_vector_union_type_value.bin`
-Changed one byte at 0x0131 from `02` to `FF` which is a vector union type value
-that is larger than the enum.
\ No newline at end of file
+Changed one byte at 0x0131 from `02` to `FF` which is a vector union type value
+that is larger than the enum.
