jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fixes strictnotnil documentation; comment unfinished sections (#21041)

Browse source 
fixes documentation; comment unfinished sections
This commit is contained in:
ringabout 2022-12-08 10:06:48 +08:00 • committed by GitHub
commit 4da3ead294
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/manual_experimental_strictnotnil.md
View file

@ -74,7 +74,9 @@ local turn on/off
--------------------- ---------------------
You can still turn off nil checking on function/module level by using a `{.strictNotNil: off.}` pragma. You can still turn off nil checking on function/module level by using a `{.strictNotNil: off.}` pragma.
Note: test that/TODO for code/manual.
..
Note: test that/TODO for code/manual.
nilability state nilability state
----------------- -----------------
@ -101,7 +103,8 @@ Types are either nilable or non-nilable.
When you pass a param or a default value, we use the type : for nilable types we return `MaybeNil` When you pass a param or a default value, we use the type : for nilable types we return `MaybeNil`
and for non-nilable `Safe`. and for non-nilable `Safe`.
TODO: fix the manual here. (This is not great, as default values for non-nilables and nilables are usually actually `nil` , so we should think a bit more about this section.) ..
TODO: fix the manual here. (This is not great, as default values for non-nilables and nilables are usually actually `nil` , so we should think a bit more about this section.)
params rules params rules
------------ ------------
@ -236,11 +239,11 @@ e.g.
left = nil # moving out left = nil # moving out
``` ```
..
initialization of non nilable and nilable values
-------------------------------------------------
initialization of non nilable and nilable values TODO
-------------------------------------------------
TODO
warnings and errors warnings and errors
--------------------- ---------------------