From 5a9ef6ce4dceb8fccf65974ba1cf6ff5f9eab470 Mon Sep 17 00:00:00 2001 From: Will Hawkins Date: Mon, 20 Apr 2026 05:59:27 -0400 Subject: [PATCH] documentation: Describe NOTEs Describe how/why notes are used in the code. Signed-off-by: Will Hawkins --- README.md | 15 +++++++++++++++ Sources/P4Compiler/Declarations.swift | 4 ++-- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3a15e9d..c62a60c 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,21 @@ where `` is one of: where `` can be more free-form and `` is a pithy description of the changes in the commit. +#### Notes To Self + +While coding, it may be useful to leave ourselves notes. Every note is formatted like: + + +```Swift +/// NOTE: note text +``` + +where `NOTE` can be: + +1. `TODO`: Remind us `TODO` something. +2. `ASSUME`: Remind us that we are making an assumption. +3. `NB`: Remind us that we need to remember something when reading this code. + #### Testing To run the P4RSE tests: diff --git a/Sources/P4Compiler/Declarations.swift b/Sources/P4Compiler/Declarations.swift index ebfa01f..5a9eb8e 100644 --- a/Sources/P4Compiler/Declarations.swift +++ b/Sources/P4Compiler/Declarations.swift @@ -30,7 +30,7 @@ extension Declaration: CompilableDeclaration { let declaration_compilers: [String: CompilableDeclaration.Type] = [ "function_declaration": FunctionDeclaration.self, "control_declaration": Control.self, - "type_declaration": StructDeclaration.self, // Assume that type declarations are struct declarations. + "type_declaration": StructDeclaration.self, // ASSUME: Type declarations are struct declarations. ] guard let declaration_compiler = declaration_compilers[node.nodeType!] else { @@ -274,7 +274,7 @@ extension P4Lang.Parser: CompilableDeclaration { let type_node = currentChild var parser_name: Common.Identifier? = .none - // Assume that the parameter list is empty! + // TODO: Handle parser parameter lists. var parameter_list = ParameterList() do {