From 0bf6a668208c65c980648fbe74a8c0a7bf4ded77 Mon Sep 17 00:00:00 2001 From: Ellie Hermaszewska Date: Wed, 20 Nov 2024 01:08:20 +0800 Subject: Markdown emphasis corrections (#5588) * Add markdown formatting to extras/formatting.sh * Correct formatting in markdown * Warn on unrecognized argument in formatting script * Print all diffs in formatting script * Correct markdown emph formatting * Don't format markdown by default --------- Co-authored-by: Yong He --- CONTRIBUTION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTION.md') diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 279faff3c..69e7dab4a 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -243,7 +243,7 @@ Here are a few highlights 1. Don't use the STL containers, iostreams, or the built-in C++ RTTI system. 1. Don't use the C++ variants of C headers (e.g., use `` instead of ``). 1. Don't use exceptions for non-fatal errors (and even then support a build flag to opt out of exceptions). -1. Types should use UpperCamelCase, values should use lowerCamelCase, and macros should use SCREAMING_SNAKE_CASE with a prefix `SLANG_`. +1. Types should use UpperCamelCase, values should use lowerCamelCase, and macros should use `SCREAMING_SNAKE_CASE` with a prefix `SLANG_`. 1. Global variables should have a `g` prefix, non-const static class members can have an `s` prefix, constant data (in the sense of static const) should have a `k` prefix, and an `m_` prefix on member variables and a `_` prefix on member functions are allowed. 1. Prefixes based on types (e.g., p for pointers) should never be used. 1. In function parameter lists, an `in`, `out`, or `io` prefix can be added to a parameter name to indicate whether a pointer/reference/buffer is intended to be used for input, output, or both input and output. -- cgit v1.2.3