Skip to content

Commit

Permalink
Verify spelling fixes pass check-spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
jsoref authored Nov 27, 2023
2 parents 6d5fb10 + 357afee commit f6c5130
Show file tree
Hide file tree
Showing 174 changed files with 573 additions and 573 deletions.
2 changes: 1 addition & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# See https://github.com/actions/labeler for file format
# and https://github.com/google/flatbuffers/labels for a list of valid labels
#
# See .github/workflows/label.yml for Github Action workflow script
# See .github/workflows/label.yml for GitHub Action workflow script

c#:
- '**/*.cs'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ jobs:
run: mvn test

build-kotlin-macos:
name: Build Kotlin MacOS
name: Build Kotlin macOS
runs-on: macos-latest
steps:
- name: Checkout
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ necessarily listed.

## [23.1.21 (Jan 21 2023)](https://github.com/google/flatbuffers/releases/tag/v23.1.20)

* Reworked entry points for Typescript/Javascript and compatibility for single
* Reworked entry points for TypeScript/JavaScript and compatibility for single
file build (#7510)

## [23.1.20 (Jan 20 2023)](https://github.com/google/flatbuffers/releases/tag/v23.1.20)
Expand Down
4 changes: 2 additions & 2 deletions CMake/BuildFlatBuffers.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ function(flatbuffers_generate_headers)
list(APPEND all_generated_source_files ${generated_source_file})
list(APPEND generated_custom_commands "${generated_include}" "${generated_source_file}")

# Geneate the binary flatbuffers schemas if instructed to.
# Generate the binary flatbuffers schemas if instructed to.
if (NOT ${FLATBUFFERS_GENERATE_HEADERS_BINARY_SCHEMAS_DIR} STREQUAL "")
set(binary_schema
"${FLATBUFFERS_GENERATE_HEADERS_BINARY_SCHEMAS_DIR}/${filename}.bfbs")
Expand Down Expand Up @@ -339,7 +339,7 @@ endfunction()
# can also specify other flagc flags and options to change the behavior of the
# flatc compiler.
#
# Adding this target to your executable ensurses that the flatbuffer binaries
# Adding this target to your executable ensures that the flatbuffer binaries
# are compiled before your executable is run.
#
# Arguments:
Expand Down
2 changes: 1 addition & 1 deletion CMake/PackageRedhat.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ if (UNIX)
set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_SOURCE_DIR}/LICENSE)
set(CPACK_PACKAGE_DESCRIPTION_FILE ${CMAKE_SOURCE_DIR}/CMake/DESCRIPTION.txt)

# This may reduce rpm compatiblity with very old systems.
# This may reduce rpm compatibility with very old systems.
set(CPACK_RPM_COMPRESSION_TYPE lzma)

set(CPACK_RPM_PACKAGE_NAME "flatbuffers")
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ include_directories(grpc)

# Creates an interface library that stores the configuration settings that each
# target links too. This is a compromise between setting configuration globally
# with add_compile_options() and the more targetted target_compile_options().
# with add_compile_options() and the more targeted target_compile_options().
# This way each target in this file can share settings and override them if
# needed.
add_library(ProjectConfig INTERFACE)
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ frustration later on.

# Code reviews
All submissions, including submissions by project members, require review. We
use Github pull requests for this purpose.
use GitHub pull requests for this purpose.

Some tips for good pull requests:
* Use our code
Expand Down
4 changes: 2 additions & 2 deletions Formatters.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ C++ uses `clang-format` as it's formatter. Run the following script `sh scripts/

Swift uses swiftformat as it's formatter. Take a look at [how to install here](https://github.com/nicklockwood/SwiftFormat/blob/master/README.md#how-do-i-install-it). Run the following command `swiftformat --config swift.swiftformat .` in the root directory of the project

## Typescript
## 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
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ maximum memory efficiency. It allows you to directly access serialized data with

1. Build the compiler for flatbuffers (`flatc`)

Use `cmake` to create the build files for your platform and then perform the compliation (Linux example).
Use `cmake` to create the build files for your platform and then perform the compilation (Linux example).

```
cmake -G "Unix Makefiles"
Expand Down
2 changes: 1 addition & 1 deletion dart/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 23.5.26

- omit type annotationes for local variables (#7067, #7069, #7070)
- omit type annotations for local variables (#7067, #7069, #7070)
- remove BSD 3-clause license (#7073)
- correctly parse lists of enums (#7157)
- align naming conventions for generated code (#7187)
Expand Down
4 changes: 2 additions & 2 deletions dart/lib/flat_buffers.dart
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ class Builder {
_currentTableEndTail = _tail;
}

/// Finish a Struct vector. Most callers should preferto use [writeListOfStructs].
/// Finish a Struct vector. Most callers should prefer to use [writeListOfStructs].
///
/// Most callers should prefer [writeListOfStructs].
int endStructVector(int count) {
Expand Down Expand Up @@ -641,7 +641,7 @@ class Builder {
return result;
}

/// Write the given list of bools as unsigend 8-bit integer [values].
/// Write the given list of bools as unsigned 8-bit integer [values].
int writeListBool(List<bool> values) {
return writeListUint8(values.map((b) => b ? 1 : 0).toList());
}
Expand Down
4 changes: 2 additions & 2 deletions dart/test/flat_buffers_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ main() {
defineReflectiveSuite(() {
defineReflectiveTests(BuilderTest);
defineReflectiveTests(ObjectAPITest);
defineReflectiveTests(CheckOtherLangaugesData);
defineReflectiveTests(CheckOtherLanguagesData);
defineReflectiveTests(GeneratorTest);
defineReflectiveTests(ListOfEnumsTest);
});
Expand All @@ -27,7 +27,7 @@ int indexToField(int index) {
}

@reflectiveTest
class CheckOtherLangaugesData {
class CheckOtherLanguagesData {
test_cppData() async {
List<int> data = await io.File(path.join(
path.context.current,
Expand Down
2 changes: 1 addition & 1 deletion dart/test/flex_reader_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ void main() {
[true, false, true, true]);
});

test('bug where offest were stored as int instead of uint', () {
test('bug where offset were stored as int instead of uint', () {
const data = [
99,
104,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and pugixml, also one of the fastest XML parsers.
We also compare against code that doesn't use a serialization library
at all (the column "Raw structs"), which is what you get if you write
hardcoded code that just writes structs. This is the fastest possible,
but of course is not cross platform nor has any kind of forwards /
but of course it is not cross platform and it has no forwards /
backwards compatibility.

We compare against Flatbuffers with the binary wire format (as
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Building.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ flexibility for users of Flatbuffers to use newer compilers and toolsets that
may add new warnings that would cause a build failure.

To enable a stricter build that does treat warnings as errors, set the
`FLATBUFFERS_STRICT_MODE` `cmake` compliation flag to `ON`.
`FLATBUFFERS_STRICT_MODE` `cmake` compilation flag to `ON`.

```
cmake . -DFLATBUFFERS_STRICT_MODE=ON
Expand Down
2 changes: 1 addition & 1 deletion docs/source/CUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ JSON parsers, printers.
Great care has been taken to ensure compatibility with the main `flatc`
project.

## General Documention
## General Documentation

- [Tutorial](@ref flatbuffers_guide_tutorial) - select C as language
when scrolling down
Expand Down
6 changes: 3 additions & 3 deletions docs/source/Compiler.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,12 +159,12 @@ Additional options:

- `--object-suffix` : Customise class suffix for C++ object-based API.

- `--go-namespace` : Generate the overrided namespace in Golang.
- `--go-namespace` : Generate the overridden namespace in Golang.

- `--go-import` : Generate the overrided import for flatbuffers in Golang.
- `--go-import` : Generate the overridden import for flatbuffers in Golang.
(default is "github.com/google/flatbuffers/go").

- `--raw-binary` : Allow binaries without a file_indentifier to be read.
- `--raw-binary` : Allow binaries without a file_identifier to be read.
This may crash flatc given a mismatched schema.

- `--size-prefixed` : Input binaries are size prefixed buffers.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/CppUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ Finally, the following top-level attributes:
# External references

An additional feature of the object API is the ability to allow you to load
multiple independent FlatBuffers, and have them refer to eachothers objects
multiple independent FlatBuffers, and have them refer to each others objects
using hashes which are then represented as typed pointers in the object API.

To make this work have a field in the objects you want to referred to which is
Expand Down
2 changes: 1 addition & 1 deletion docs/source/DartUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ var pos = monster.pos;

## Differences from the Dart SDK Front End flat_buffers

The work in this repository is signfiicantly based on the implementation used
The work in this repository is significantly based on the implementation used
internally by the Dart SDK in the front end/analyzer package. Several
significant changes have been made.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/RustUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ and [Writing a schema](@ref flatbuffers_guide_writing_schema).
Assuming you wrote a schema, say `mygame.fbs` (though the extension doesn't
matter), you've generated a Rust file called `mygame_generated.rs` using the
compiler (e.g. `flatc --rust mygame.fbs` or via helpers listed in "Useful
tools created by others" section bellow), you can now start using this in
tools created by others" section below), you can now start using this in
your program by including the file. As noted, this header relies on the crate
`flatbuffers`, which should be in your include `Cargo.toml`.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/Schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ mechanism for forward and backwards compatibility. Note that:
stop writing them into your data for almost the same effect.
Additionally you can mark them as `deprecated` as in the example
above, which will prevent the generation of accessors in the
generated C++, as a way to enforce the field not being used any more.
generated C++, as a way to enforce the field not being used anymore.
(careful: this may break code!).

- You may change field names and table names, if you're ok with your
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Support.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Platform: iOS | ? | ? | ? | ? | ? | ?
Engine: Unity | ? | ? | Yes | ? | ? | ? | ? | ? | ? | ? | No | ? | No
Primary authors (github) | aard | aard | ev/js/df | rw | rw | ew/ev | kr | mik | ch | df | aard | rw/cn | mi/mz

Above | Github username
Above | GitHub username
----- | -----------------------------
aard | aardappel (previously: gwvo)
ch | chobie
Expand Down
2 changes: 1 addition & 1 deletion docs/source/SwiftUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ added to xcode or the path of the package you will be using. Note: sometimes xco
and wont see the generated files, so it's better that you copy them to xcode.

For example, here is how you would read a FlatBuffer binary file in Swift: First,
include the library and copy thegenerated code. Then read a FlatBuffer binary file or
include the library and copy the generated code. Then read a FlatBuffer binary file or
a data object from the server, which you can pass into the `GetRootAsMonster` function.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.swift}
Expand Down
8 changes: 4 additions & 4 deletions docs/source/Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Please select your desired language for our quest:

## Where to Find the Example Code

Samples demonstating the concepts in this example are located in the source code
Samples demonstrating the concepts in this example are located in the source code
package, under the `samples` directory. You can browse the samples on GitHub
[here](https://github.com/google/flatbuffers/tree/master/samples).

Expand Down Expand Up @@ -1778,7 +1778,7 @@ a bit more flexibility.
//ns(Monster_pos_add(&pos);
ns(Monster_hp_add(B, hp));
// Notice that `Monser_name_add` adds a string reference unlike the
// Notice that `Monster_name_add` adds a string reference unlike the
// add_str and add_strn variants.
ns(Monster_name_add(B, name));
ns(Monster_inventory_add(B, inventory));
Expand Down Expand Up @@ -3431,14 +3431,14 @@ table Movie {

#### Creating

Analagously to how a union adds two fields to a table a vector of unions creates two different vectors:
Analogously to how a union adds two fields to a table a vector of unions creates two different vectors:
one for the union data and one for the data types.

<div class="language-cpp">
C++ supports vectors of unions, but it isn't currently documented.
</div>
<div class="language-typescript">
Typescript supports vectors of unions, but it isn't currently documented.
TypeScript supports vectors of unions, but it isn't currently documented.
</div>
<div class="language-php">
PHP supports vectors of unions, but it isn't currently documented.
Expand Down
16 changes: 8 additions & 8 deletions docs/source/doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ QT_AUTOBRIEF = NO
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# not recognized anymore.
# The default value is: NO.

MULTILINE_CPP_IS_BRIEF = NO
Expand Down Expand Up @@ -268,7 +268,7 @@ OPTIMIZE_OUTPUT_VHDL = NO
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
# (default is Fortran), use: inc=Fortran f=C.
Expand Down Expand Up @@ -493,7 +493,7 @@ INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
# names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# in case and if your file system supports case-sensitive file names. Windows
# and Mac users are advised to set this option to NO.
# The default value is: system dependent.

Expand Down Expand Up @@ -645,7 +645,7 @@ SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command command input-file, where command is the value of the
# popen()) the command input-file, where command is the value of the
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
# by doxygen. Whatever the program writes to standard output is used as the file
# version. For an example see the documentation.
Expand Down Expand Up @@ -1472,7 +1472,7 @@ EXT_LINKS_IN_WINDOW = NO

FORMULA_FONTSIZE = 10

# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are not
# supported properly for IE 6.0, but are supported on all modern browsers.
#
Expand All @@ -1484,7 +1484,7 @@ FORMULA_FONTSIZE = 10
FORMULA_TRANSPARENT = YES

# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# http://www.mathjax.org) which uses client side Javascript for the rendering
# http://www.mathjax.org) which uses client side JavaScript for the rendering
# instead of using prerendered bitmaps. Use this if you do not have LaTeX
# installed or if you want to formulas look prettier in the HTML output. When
# enabled you may also need to install MathJax separately and configure the path
Expand Down Expand Up @@ -1554,7 +1554,7 @@ MATHJAX_CODEFILE =
SEARCHENGINE = YES

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. There
# implemented using a web server instead of a web client using JavaScript. There
# are two flavours of web server based searching depending on the
# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
# searching and an index file used by the script. When EXTERNAL_SEARCH is
Expand Down Expand Up @@ -2032,7 +2032,7 @@ PREDEFINED =
EXPAND_AS_DEFINED =

# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all refrences to function-like macros that are alone on a line, have an
# remove all references to function-like macros that are alone on a line, have an
# all uppercase name, and do not end with a semicolon. Such function macros are
# typically used for boiler-plate code, and will confuse the parser if not
# removed.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/gRPC/CppUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ We will illustrate usage with the following schema:

@include grpc/samples/greeter/greeter.fbs

When we run `flatc`, we pass in the `--grpc` option and generage an additional
When we run `flatc`, we pass in the `--grpc` option and generate an additional
`greeter.grpc.fb.h` and `greeter.grpc.fb.cc`.

Example server code looks like this:
Expand Down
4 changes: 2 additions & 2 deletions go/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ func (b *Builder) StartObject(numfields int) {

// WriteVtable serializes the vtable for the current object, if applicable.
//
// Before writing out the vtable, this checks pre-existing vtables for equality
// Before writing out the vtable, this checks preexisting vtables for equality
// to this one. If an equal vtable is found, point the object to the existing
// vtable and return.
//
Expand Down Expand Up @@ -586,7 +586,7 @@ func (b *Builder) Slot(slotnum int) {
}

// FinishWithFileIdentifier finalizes a buffer, pointing to the given `rootTable`.
// as well as applys a file identifier
// as well as applies a file identifier
func (b *Builder) FinishWithFileIdentifier(rootTable UOffsetT, fid []byte) {
if fid == nil || len(fid) != fileIdentifierLength {
panic("incorrect file identifier length")
Expand Down
2 changes: 1 addition & 1 deletion go/lib.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func GetSizePrefix(buf []byte, offset UOffsetT) uint32 {
return GetUint32(buf[offset:])
}

// GetIndirectOffset retrives the relative offset in the provided buffer stored at `offset`.
// GetIndirectOffset retrieves the relative offset in the provided buffer stored at `offset`.
func GetIndirectOffset(buf []byte, offset UOffsetT) UOffsetT {
return offset + GetUOffsetT(buf[offset:])
}
Expand Down
2 changes: 1 addition & 1 deletion goldens/golden_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


def flatc_golden(options, schema, prefix):
# wrap the generic flatc call with specifis for these goldens.
# wrap the generic flatc call with specifics for these goldens.
flatc(
options=options,
# where the files are generated, typically the language (e.g. "cpp").
Expand Down
Loading

0 comments on commit f6c5130

Please sign in to comment.