Skip to content

Commit 27325e0

Browse files
authored
docs: clean up whitespace and fix typo in tutorial.md (#8695)
* docs: remove trailing whitespace * docs: fix typo in tutorial.md
1 parent 1872409 commit 27325e0

File tree

26 files changed

+108
-108
lines changed

26 files changed

+108
-108
lines changed

Formatters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ Swift uses swiftformat as it's formatter. Take a look at [how to install here](h
1919

2020
## Typescript
2121

22-
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
22+
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

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ maximum memory efficiency. It allows you to directly access serialized data with
3434
```
3535
./flatc --cpp --rust monster.fbs
3636
```
37-
37+
3838
Which generates `monster_generated.h` and `monster_generated.rs` files.
3939
4040
4. Serialize data
@@ -48,7 +48,7 @@ maximum memory efficiency. It allows you to directly access serialized data with
4848
6. Read the data
4949
5050
Use the generated accessors to read the data from the serialized buffer.
51-
51+
5252
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++`.
5353
5454
## Documentation

benchmarks/swift/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ To open the benchmarks in xcode use:
66

77
or running them directly within terminal using:
88

9-
`swift package benchmark`
9+
`swift package benchmark`

docs/source/annotation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ The columns are as follows:
5555
The prefix `+` is added to make searching for the offset (compared to some
5656
random value) a bit easier.
5757

58-
2. The raw binary data, expressed in hexadecimal format.
59-
58+
2. The raw binary data, expressed in hexadecimal format.
59+
6060
This is in the little endian format the buffer uses internally and what you
6161
would see with a normal binary text viewer.
6262

@@ -108,7 +108,7 @@ regions in the flatbuffer itself.
108108

109109
### Binary Regions
110110

111-
Binary regions are contiguous bytes regions that are grouped together to form
111+
Binary regions are contiguous bytes regions that are grouped together to form
112112
some sort of value, e.g. a `scalar` or an array of scalars. A binary region may
113113
be split up over multiple text lines, if the size of the region is large.
114114

@@ -122,7 +122,7 @@ vtable (AnnotatedBinary.Bar):
122122
```
123123

124124
The first column (`+0x00A0`) is the offset to this region from the beginning of
125-
the buffer.
125+
the buffer.
126126

127127
The second column are the raw bytes (hexadecimal) that make up this region.
128128
These are expressed in the little-endian format that flatbuffers uses for the
@@ -135,7 +135,7 @@ The fourth column shows the raw bytes as a compacted, big-endian value. The raw
135135
bytes are duplicated in this fashion since it is more intuitive to read the data
136136
in the big-endian format (e.g., `0x0008`). This value is followed by the decimal
137137
representation of the value (e.g., `(8)`). For strings, the raw string value is
138-
shown instead.
138+
shown instead.
139139

140140
The fifth column is a textual comment on what the value is. As much metadata as
141141
known is provided.
@@ -146,4 +146,4 @@ If the type in the 3rd column is of an absolute offset (`SOffet32` or
146146
`Offset32`), the fourth column also shows an `Loc: +0x025A` value which shows
147147
where in the binary this region is pointing to. These values are absolute from
148148
the beginning of the file, their calculation from the raw value in the 4th
149-
column depends on the context.
149+
column depends on the context.

docs/source/building.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,11 +152,11 @@ add_subdirectory(${FLATBUFFERS_SRC_DIR}
152152
# The flatbuffers target carry header search path automatically if CMake > 2.8.11.
153153
target_link_libraries(own_project_target PRIVATE flatbuffers)
154154
```
155-
When build your project the `flatbuffers` library will be compiled and linked
155+
When build your project the `flatbuffers` library will be compiled and linked
156156
to a target as part of your project.
157157

158158
#### Override default depth limit of nested objects
159-
To override [the depth limit of recursion](languages/cpp.md),
159+
To override [the depth limit of recursion](languages/cpp.md),
160160
add this directive:
161161
```cmake
162162
set(FLATBUFFERS_MAX_PARSING_DEPTH 16)
@@ -174,4 +174,4 @@ We generate [SLSA3 signatures](http://slsa.dev) using the OpenSSF's [slsa-framew
174174
```shell
175175
$ slsa-verifier -artifact-path <downloaded.zip> -provenance attestation.intoto.jsonl -source github.com/google/flatbuffers -tag <version>
176176
PASSED: Verified SLSA provenance
177-
```
177+
```

docs/source/contributing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ repository.
1515
Before we can use your contributions, you __must__ sign one of the following license agreements. The agreements are self-served at the following links.
1616

1717
Our code review process will automatically check if you have signed the CLA, so
18-
don't fret. Though it may be prudent to check before spending a lot of time on
18+
don't fret. Though it may be prudent to check before spending a lot of time on
1919
contribution.
2020

21-
### Individual Contributions
21+
### Individual Contributions
2222

2323
For individuals, the [Google Individual
2424
Contributor License Agreement
2525
(CLA)](https://cla.developers.google.com/about/google-individual?csw=1) which is
2626
self served at the link. The CLA is required since you own the copyright to your
2727
changes, even after your contribution becomes part of our codebase, so we need
28-
your permission to use and distribute your code.
28+
your permission to use and distribute your code.
2929

3030
### Corporate Contributions
3131

@@ -67,7 +67,7 @@ pip install mkdocs-material
6767
pip install mkdocs-redirects
6868
```
6969

70-
Then, in the `root` directory of flatbuffers, run
70+
Then, in the `root` directory of flatbuffers, run
7171

7272
```
7373
mkdocs serve -f docs/mkdocs.yml
@@ -77,4 +77,4 @@ This will continually watch the repo for changes to the documentation and serve
7777
the rendered pages locally.
7878

7979
Submit your documentation changes with your code changes and they will
80-
automatically get published when your code is submitted.
80+
automatically get published when your code is submitted.

docs/source/evolution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ a [option](flatc.md#additional-options) to do just that:
261261

262262
```sh
263263
--conform FILE
264-
```
264+
```
265265

266266
Where `FILE` is the base schema the rest of the input schemas must evolve from.
267267
It returns `0` if they are properly evolved, otherwise returns a non-zero value

docs/source/flatc.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# FlatBuffers Compiler (`flatc`)
22

33
The main compiler for FlatBuffers is called `flatc` and is used to convert
4-
schema definitions into generated code files for a variety of languages.
4+
schema definitions into generated code files for a variety of languages.
55

66
After [building](building.md) `flatc`, it is used as follows:
77

88
```sh
9-
flatc [ GENERATOR_OPTIONS ] [ -o PATH ] [- I PATH ]
10-
FILES...
9+
flatc [ GENERATOR_OPTIONS ] [ -o PATH ] [- I PATH ]
10+
FILES...
1111
[ -- BINARY_FILES... ]
1212
```
1313

@@ -65,17 +65,17 @@ list of `FILES...`.
6565
=== "To Binary"
6666

6767
To serialize the JSON data in `mydata.json` using the schema `myschema.fbs`:
68-
68+
6969
```sh
7070
flatc --binary myschema.fbs mydata.json
7171
```
7272

73-
This will generate a `mydata_wire.bin` file containing the serialized
73+
This will generate a `mydata_wire.bin` file containing the serialized
7474
flatbuffer data.
7575

7676
=== "To JSON"
7777

78-
To convert the serialized binary flatbuffer `mydata.bin` using the schema
78+
To convert the serialized binary flatbuffer `mydata.bin` using the schema
7979
`myschema.fbs` to JSON:
8080

8181
```sh

docs/source/intermediate_representation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ errors and stores the resulting data in this IR, outputting `.bfbs` files.
66
Since this IR is a Flatbuffer, you can load and use it at runtime for runtime
77
reflection purposes.
88

9-
There are some quirks:
9+
There are some quirks:
1010
- Tables and Structs are serialized as `Object`s.
1111
- Unions and Enums are serialized as `Enum`s.
1212
- It is the responsibility of the code generator to check the `advanced_features`
@@ -18,7 +18,7 @@ There are some quirks:
1818
inferred to be the directory containing the first provided schema file.
1919

2020

21-
## Invocation
21+
## Invocation
2222
You can invoke it like so
2323
```{.sh}
2424
flatc -b --schema ${your_fbs_files}

docs/source/languages/dart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ significant changes have been made.
9393
goal of this implementation. Support for 16 bit integers was also added.
9494
5. The code generation in this offers an "ObjectBuilder", which generates code
9595
very similar to the SDK classes that consume FlatBuffers, as well as Builder
96-
classes, which produces code which more closely resembles the builders in
96+
classes, which produces code which more closely resembles the builders in
9797
other languages. The ObjectBuilder classes are easier to use, at the cost of
9898
additional references allocated.
9999

0 commit comments

Comments
 (0)