x/clean-code-typescript
1
0
Fork 0
mirror of https://github.com/labs42io/clean-code-typescript.git synced 2025-04-18 15:13:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Addressing comments of #59:

Browse source 
- Removed "/Avoid magic literals" from the header to avoid noise.
- Added back unnamed constants and kept magic strings, magic numbers as a note at the end of the paragraph.
This commit is contained in:
Ioannis Brant-Ioannidis 2023-02-14 21:38:56 +04:00
parent 36d14bf048
commit d1e2cfb632
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -117,9 +117,9 @@ function getUser(): User;
**[⬆ back to top](#table-of-contents)**
### Use searchable names / Avoid Magic Literals
### Use searchable names
We will read more code than we will ever write. It's important that the code we do write must be readable and searchable. By *not* naming variables that end up being meaningful for understanding our program, we hurt our readers. Make your names searchable. Tools like [ESLint](https://typescript-eslint.io/) can help identify magic literals.
We will read more code than we will ever write. It's important that the code we do write must be readable and searchable. By *not* naming variables that end up being meaningful for understanding our program, we hurt our readers. Make your names searchable. Tools like [ESLint](https://typescript-eslint.io/) can help identify unnamed constants (also known as magic strings and magic numbers).
**Bad:**