enso-org/enso
1
1
Fork 0
mirror of https://github.com/enso-org/enso.git synced 2024-08-16 16:30:33 +03:00
Code Issues Projects Releases Wiki Activity

Update 'naming' docs (#3858)

Browse Source
This commit is contained in:
Hubert Plociniczak 2022-11-24 13:55:42 +01:00 committed by GitHub
parent f225a962ce
commit 5b434d19c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/syntax/naming.md
View File

@ -44,11 +44,10 @@ following rules around naming:
- Each 'word' in the identifier must be lower-case or a number.
- Words in the identifier are separated using `_`.
- Numbers may not occur as the first 'word' in an identifier.
- An identifier named as above can be referred to by capitalizing the first
letter of each 'word' in the identifier. This is known as 'referent' form.
- No mixed-format names are allowed (e.g. `HTTP`, `foO`, `make_New`, or
`Make_new`). These should be rejected by the compiler.
- Mixed-format names are allowed (e.g. `HTTP`, `foO`, `AWS_Profile`, or
`SQLite`).
- We _strongly encourage_ using capitalised identifiers to refer to atoms.
- All names are case-sensitive.
Name resolution obeys the following rules:
@ -173,7 +172,6 @@ the readability and consistency of Enso code. They are as follows:
to the operation of control flow in the language.
- `this`: This reserved name is the one used to refer to the enclosing type in a
method or type definition.
- `here`: This reserved name is the one used to refer to the enclosing module.
- `in`: Used to specify the monadic context(s) in a type signature.
Many of these reserved words are implemented as macros in the parser, but these