Skip to content

Commit 1af7329

Browse files
authored
Update PRINCIPLES.md
Add the unsafe fn marker practice and links
1 parent 58febb2 commit 1af7329

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

PRINCIPLES.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@ This library is an experiment and not intended for use. See the
1010
1. Memory safety should be the default. You don't pay (in bugs and CVEs) for
1111
premature optimization you didn't need.
1212
* Leaving this path should require more typing, and a clear signal what is
13-
happening. We will use either a naming convention, or a marker argument
14-
type, to do so in place of [a language keyword](
13+
happening. We will use [a naming convention of "unchecked"](
14+
https://github.com/chromium/subspace/blob/9d0ae908aa8a98d11f78e0315470be64b97a0dbe/mem/nonnull.h#L31),
15+
and [a marker argument type of `UnsafeFnMarker`](
16+
https://github.com/chromium/subspace/blob/main/marker/unsafe.h),
17+
to do so in place of [a language keyword](
1518
https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/unsafe).
1619
1. KISS Principle
1720
* "most systems work best if they are kept simple rather than made

0 commit comments

Comments
 (0)