rubygems
/
zeitwerk
1
0
Fork 0
Code Packages Releases Activity

Link to the RBS syntax reference in PROJECT_RULES.md

This commit is contained in:
Xavier Noria 2022-11-04 06:52:45 +01:00
parent f3a43e5cf2
commit 53558e1c3c
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
PROJECT_RULES.md
View File

@ -35,7 +35,7 @@ Note that Zeitwerk does not deal with file or directory objects, only with paths
## Types
* All methods should have a documented signature.
* All methods should have a documented signature using [RBS syntax](https://github.com/ruby/rbs/blob/master/docs/syntax.md).
* Use the most concise type always. Use a set when a set is the best choice, use `Module` when a class or module object is the natural data type (rather than its name).
* Use always symbols for constant names.
* Use always strings for constant paths.