Fix multiple grammar and spelling issues in docs #1212
Conversation
|
Oh, that's huge 😅 it will take me a while to review. I guess splitting it in multiple PRs per doc isn't an option, is it? |
|
It would certainly be possible, but I'm not sure if it would be worth it. In general, take as much time as you want reviewing this. You can also review each page seperately if you want that 😄 Also funny how codecov is failing, quota reached |
docs/md/core.md
Outdated
| @@ -873,7 +873,7 @@ where constant expressions are required. | |||
|
|
|||
| As long as the list remains unchanged, identifiers are also guaranteed to be | |||
| stable across different runs. In case they have been used in a production | |||
| environment and a type has to be removed, one can just use a placeholder to | |||
| environment, and a type has to be removed; one can just use a placeholder to | |||
There was a problem hiding this comment.
fair, I think having there be a dot instead feels good
| such as the connection objects or the possibility to attach listeners with a | ||
| list of parameters that is shorter than that of the signal itself. | ||
| list of parameters that are shorter than that of the signal itself. |
There was a problem hiding this comment.
The list is shorter. I think this fix is wrong actually, isn't it?
There was a problem hiding this comment.
depends if you are referring to the list being shorter or the parameter in the list being shorter
There was a problem hiding this comment.
I assume the first, so this fix is likely incorrect
There was a problem hiding this comment.
Yeah, exactly, the list is shorter in this case.
docs/md/entity.md
Outdated
| reduce the boilerplate in the most complex cases. | ||
|
|
||
| ### Handle | ||
|
|
||
| A handle is a thin wrapper around an entity and a registry. It _replicates_ the | ||
| API of a registry by offering functions such as `get` or `emplace`. The | ||
| difference being that the entity is implicitly passed to the registry.<br/> | ||
| It's default constructible as an invalid handle that contains a null registry | ||
| It is default-constructible as an invalid handle that contains a null registry |
There was a problem hiding this comment.
Uhm, default constructible is quite common in C++ actually. I don't think this one is correct in this sense.
There was a problem hiding this comment.
After some research it actually is more formal and it aligns with established naming conventions like those in the C++ stl
|
Thank you very much for the review! |
|
should have cover most of your concerns now, sorry for the rather late fixes |
|
No need to apologize. I'm doing as you suggested and reviewing one file at a time when I can. I still have some work to do, actually! 🙂 |
| @@ -873,7 +873,7 @@ where constant expressions are required. | |||
|
|
|||
| As long as the list remains unchanged, identifiers are also guaranteed to be | |||
| stable across different runs. In case they have been used in a production | |||
| environment and a type has to be removed, one can just use a placeholder to | |||
| environment, and a type has to be removed. One can just use a placeholder to | |||
There was a problem hiding this comment.
Oh, I see the misunderstanding now 😅 this is more on the line: One can do xxx in case they have been uses ..., and a type as to be removed. I flipped everything upside down in perfect Italian style, sorry for that. 🙏
| @@ -74,25 +74,25 @@ entt::meta_factory<my_type> factory{}; | |||
| The returned value is a _factory object_ to use to continue building the meta | |||
| type. | |||
|
|
|||
| By default, a meta type is associated with the identifier returned by the | |||
| By default, a meta-type is associated with the identifier returned by the | |||
There was a problem hiding this comment.
To be honest, I prefer that meta-type, meta-data and all the other meta- stuff stays the way they were before, i.e. without the -. This form is more common in general, and it also avoids confusion with things like meta-default constructor, which feels wrong.
There was a problem hiding this comment.
default meta-constructor?
This PR fixes A LOT of general grammar issues, spelling mistakes and converts the prior mix of formal and informal worlds into a coherent mess.
Also, entt is pretty cool and I enjoyed reading all the docs :)