From 548a662efd3d54e2126a5e28a1af430b44f7f34d Mon Sep 17 00:00:00 2001 From: Bikramjeet Vig Date: Mon, 30 Sep 2024 10:58:45 -0700 Subject: [PATCH] Update coding style to include debug prefix for query configs (#10934) Summary: Pull Request resolved: https://github.com/facebookincubator/velox/pull/10934 Reviewed By: xiaoxmeng Differential Revision: D62252128 Pulled By: bikramSingh91 fbshipit-source-id: 12acd1ed611a1cf0df4728d1333eef76940ff9a9 --- CODING_STYLE.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CODING_STYLE.md b/CODING_STYLE.md index ff1a29edf7a7..1f540e0c9356 100644 --- a/CODING_STYLE.md +++ b/CODING_STYLE.md @@ -62,6 +62,11 @@ line width, indentation and ordering (for includes, using directives and etc).  their public APIs. Only use test methods in rare edge cases where this is not possible. For example, MemoryAllocator::testingSetFailureInjection() is used to to inject various memory allocation failures to test error handling paths. +* Use the **debug** prefix for query configs that are intended for debugging + purposes only. These configs may enable expensive checks or disable selective + code paths, and are not recommended for use in production environments. For + example, `debug_disable_expression_with_peeling` is used to disable peeling + optimization employed in expression evaluation. ## Comments