Replace 'entity' identifier example from cdl.md #1982
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the "Keywords & Identifiers" section there's an example of the keyword `entity` being used as an identifier, which seems confusing and "asking for trouble" :-) Moreover, a little further on, in a "Warning" section, it states "Delimited identifiers in general, but in particular non-ASCII characters, _or keywords as identifiers_ should be avoided as much as possible, for reasons of interoperability." (emphasis mine). In addition, the definition of the `entity` aspect also had an `Integer` key called `ID`, which is perhaps not to be universally encouraged (better to use `cuid` with its `UUID` type). So I reworked this section.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the "Keywords & Identifiers" section there's an example of the keyword
entitybeing used as an identifier, which seems confusing and "asking for trouble" :-)Moreover, a little further on, in a "Warning" section, it states "Delimited identifiers in general, but in particular non-ASCII characters, or keywords as identifiers should be avoided as much as possible, for reasons of interoperability." (emphasis mine).
In addition, the definition of the
entityaspect also had anIntegerkey calledID, which is perhaps not to be universally encouraged (better to usecuidwith itsUUIDtype).So I reworked this section.