Differences

This shows you the differences between two versions of the page.

--- file_naming_conventions [2026-05-31 05:12 pm] – hcho
+++ file_naming_conventions [2026-05-31 06:21 pm] (current) – [Technical identifiers] hcho
@@ Line 8: / Line 8: @@
   * Use only lowercase letters (a-z), digits (0-9), hyphens (-), and underscores (_).
   * Avoid spaces and other special characters.
-  * Use **hyphens (-)** for named entities intended primarily for human reading.
+  * Use **hyphens (-)** for named entities intended primarily for human reading and reference.
   * Use **underscores (_)** for technical identifiers intended primarily for software, programming languages, databases, GIS, and other computational environments.
+===== Directory names =====
+Directory names use **hyphens**, unless the directory represents a software package that must follow programming naming rules.
+Examples:
+  submission-docs/
+  review-response/
+  fig-study-area/
+  build-scripts/
 ===== Documentation and manuscripts =====
@@ Line 27: / Line 38: @@
 Hyphens improve readability and match conventions commonly used in documentation, URLs, and open-source repositories.
-===== Command-line tools =====
-Command-line interface (CLI) programs use **hyphens** in executable names because they are user-facing commands.
-Examples:
-  flow-direction
-  longest-flow-path
-  mesh-builder
 ===== Workflow scripts =====
@@ Line 51: / Line 52: @@
 -postprocess-results.sh
-===== Directory names =====
+===== Command-line tools =====
-Directory names use **hyphens**, unless the directory represents a software package that must follow programming naming rules.
+Command-line interface (CLI) programs use **hyphens** in executable names because they are user-facing commands.
 Examples:
-  submission-docs/
+  flow-direction
-  review-response/
+  longest-flow-path
-  fig-study-area/
+  mesh-builder
-  build-scripts/
-===== Generated files =====
-Generated files should normally keep the same base name as their source files.
-Example:
-  cover-letter.tex → cover-letter.pdf
 ===== Software source code =====
@@ Line 81: / Line 73: @@
   grid_utils.h
-===== Technical identifiers =====
+===== GIS datasets and technical identifiers =====
-Technical identifiers use **underscores** to separate words. This ensures compatibility with databases, GIS layers, raster algebra, and similar computational environments.
+GIS datasets and technical identifiers use **underscores** to separate words. This ensures compatibility with GIS layers, raster algebra, databases, and similar computational environments.
 Examples:
   gcn10_amc_i.tif
+  gcn10_amc_ii.tif
   nm_hydro_basins.gpkg
+  stream_order.parquet
+===== Generated files =====
+Generated files should normally keep the same base name as their source files.
+Example:
+  cover-letter.tex → cover-letter.pdf