Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix multiple grammar and spelling issues in docs #1212

Open
wants to merge 23 commits into
base: wip
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
9a08be9
Update config.md
theaddonn Jan 21, 2025
d74a95b
correct grammar
theaddonn Jan 21, 2025
1dddb29
fix wide chars section link
theaddonn Jan 21, 2025
d73abee
fix general grammar issues in core
theaddonn Jan 21, 2025
ca8aa11
fix general grammar issues in faq
theaddonn Jan 21, 2025
1cb320c
fix general grammar issues in graph
theaddonn Jan 21, 2025
8c14d4b
fix general grammar issues in lib
theaddonn Jan 21, 2025
a3e193d
fix general grammar and spelling issues in links.md
theaddonn Jan 21, 2025
195bed8
fix general grammar and spelling issues in locator.md
theaddonn Jan 21, 2025
7c9d51c
fix general grammar and spelling issues in meta.md
theaddonn Jan 21, 2025
4edb3c8
fix general grammar and spelling issues in poly.md
theaddonn Jan 21, 2025
205bb64
fix general grammar and spelling issues in process.md
theaddonn Jan 21, 2025
794313a
fix general grammar and spelling issues in reference.md
theaddonn Jan 21, 2025
5a1300d
fix general grammar and spelling issues in resource.md
theaddonn Jan 21, 2025
77ceb33
fix general grammar and spelling issues in signal.md
theaddonn Jan 21, 2025
376a048
use full forms in every file
theaddonn Jan 21, 2025
e8d3a85
correct can not to cannot in entity.md
theaddonn Jan 23, 2025
30998ba
fixup get_allocator code formatting
theaddonn Jan 26, 2025
dd01af1
replace default-constructible with default constructible
theaddonn Jan 26, 2025
82e6fdd
needs to replaced by needs
theaddonn Jan 26, 2025
04b865d
Replace ; with . for proper grammar
theaddonn Jan 26, 2025
29bdbf1
dehyphenate sparse set-based
theaddonn Jan 26, 2025
34a91d1
correct break
theaddonn Jan 26, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/md/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ respects. These variables are just one of the many ways to customize how it
works.<br/>
In the vast majority of cases, users will have no interest in changing the
default parameters. For all other cases, the list of possible configurations
with which it's possible to adjust the behavior of the library at runtime can be
with which it is possible to adjust the behavior of the library at runtime can be
found below.

# Definitions

All options are intended as parameters to the compiler (or user-defined macros
within the compilation units, if preferred).<br/>
Each parameter can result in internal library definitions. It's not recommended
Each parameter can result in internal library definitions. It is not recommended
to try to also modify these definitions, since there is no guarantee that they
will remain stable over time unlike the options below.

Expand All @@ -42,10 +42,10 @@ also limited to this library only.

## ENTT_USE_ATOMIC

In general, `EnTT` doesn't offer primitives to support multi-threading. Many of
In general, `EnTT` does not offer primitives to support multi-threading. Many of
the features can be split over multiple threads without any explicit control and
the user is the one who knows if a synchronization point is required.<br/>
However, some features aren't easily accessible to users and are made
However, some features are not easily accessible to users and are made
thread-safe by means of this definition.

## ENTT_ID_TYPE
Expand All @@ -57,24 +57,24 @@ default type if necessary.

## ENTT_SPARSE_PAGE

It's known that the ECS module of `EnTT` is based on _sparse sets_. What is less
It is known that the ECS module of `EnTT` is based on _sparse sets_. What is less
known perhaps is that the sparse arrays are paged to reduce memory usage.<br/>
Default size of pages (that is, the number of elements they contain) is 4096 but
users can adjust it if appropriate. In all case, the chosen value **must** be a
users can adjust it if appropriate. In all cases, the chosen value **must** be a
power of 2.

## ENTT_PACKED_PAGE

As it happens with sparse arrays, packed arrays are also paginated. However, in
this case the aim isn't to reduce memory usage but to have pointer stability
this case the aim is not to reduce memory usage but to have pointer stability
upon component creation.<br/>
Default size of pages (that is, the number of elements they contain) is 1024 but
users can adjust it if appropriate. In all case, the chosen value **must** be a
users can adjust it if appropriate. In all cases, the chosen value **must** be a
power of 2.

## ENTT_ASSERT

For performance reasons, `EnTT` doesn't use exceptions or any other control
For performance reasons, `EnTT` does not use exceptions or any other control
structures. In fact, it offers many features that result in undefined behavior
if not used correctly.<br/>
To get around this, the library relies on a lot of asserts for the purpose of
Expand All @@ -83,7 +83,7 @@ are allowed to overwrite its behavior by setting this variable.

### ENTT_ASSERT_CONSTEXPR

Usually, an assert within a `constexpr` function isn't a big deal. However, in
Usually, an assert within a `constexpr` function is not a big deal. However, in
case of extreme customizations, it might be useful to differentiate.<br/>
For this purpose, `EnTT` introduces an admittedly badly named variable to make
the job easier in this regard. By default, this variable forwards its arguments
Expand All @@ -109,6 +109,6 @@ dedicated storage for them.
`EnTT` mixes non-standard language features with others that are perfectly
compliant to offer some of its functionalities.<br/>
This definition prevents the library from using non-standard techniques, that
is, functionalities that aren't fully compliant with the standard C++.<br/>
is, functionalities that are not fully compliant with the standard C++.<br/>
While there are no known portability issues at the time of this writing, this
should make the library fully portable anyway if needed.
8 changes: 4 additions & 4 deletions docs/md/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@
# Introduction

The standard C++ library offers a wide range of containers and adaptors already.
It's really difficult to do better (although it's very easy to do worse, as many
It is really difficult to do better (although it is very easy to do worse, as many
examples available online demonstrate).<br/>
`EnTT` doesn't try in any way to replace what is offered by the standard. Quite
`EnTT` does not try in any way to replace what is offered by the standard. Quite
the opposite, given the widespread use that is made of standard containers.<br/>
However, the library also tries to fill a gap in features and functionalities by
making available some containers and adaptors initially developed for internal
use.

This section of the library is likely to grow larger over time. However, for the
moment it's quite small and mainly aimed at satisfying some internal needs.<br/>
moment it is quite small and mainly aimed at satisfying some internal needs.<br/>
For all containers and adaptors made available, full test coverage and stability
over time is guaranteed as usual.

Expand Down Expand Up @@ -78,7 +78,7 @@ The internal implementation is purposely supported by a tuple of containers
rather than a container of tuples. The purpose is to allow efficient access to
single columns and not just access to the entire data set of the table.

When a row is accessed, all data are returned in the form of a tuple containing
When a row is accessed, all data is returned in the form of a tuple containing
(possibly const) references to the elements of the row itself.<br/>
Similarly, when a table is iterated, tuples of references to table elements are
returned for each row.
Loading