From a2d767558e21ea249597f7779270ebbe7914888d Mon Sep 17 00:00:00 2001 From: Freya Murphy Date: Tue, 6 May 2025 16:51:32 -0400 Subject: add docstring stmt --- docs/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/README.md b/docs/README.md index 3c4f052..c5c7158 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,6 +20,12 @@ amd64 Multiboot (Legacy / UEFI) +## Docstrings + +Kernel function docstrings MUST be located in the headers. + +Docstrings for global functions MAY be in the source c files. + ## Startup 1. Multiboot loads kernel into either `_start` or `_start_efi` -- cgit v1.2.3-freya