From 249ee69d14a6ad8a5594708e28ac83d257ae9b3b Mon Sep 17 00:00:00 2001 From: Austen Sharpe <49878195+aesharpe@users.noreply.github.com> Date: Mon, 6 Jan 2025 17:10:57 -0300 Subject: [PATCH] Add boolean column naming standard to naming_conventions doc (#3998) --- docs/dev/naming_conventions.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/dev/naming_conventions.rst b/docs/dev/naming_conventions.rst index b52c4a0447..256ce5477d 100644 --- a/docs/dev/naming_conventions.rst +++ b/docs/dev/naming_conventions.rst @@ -186,6 +186,10 @@ quantities are actually different. * Regardless of what label utilities are given in the original data source (e.g. ``operator`` in EIA or ``respondent`` in FERC) we refer to them as ``utilities`` in PUDL. +* Include verb prefixes (e.g.: ``is_{x}``, ``has_{x}``, or ``served_{x}``) + to boolean columns to highlight their binary nature. (Not all columns in + the PUDL database follow this standard, but we'd like them to moving + forward). Naming Conventions in Code --------------------------