OpenWaterAnalytics / EPANET

The Water Distribution System Hydraulic and Water Quality Analysis Toolkit
MIT License
272 stars 201 forks source link

feat: Add column headings for sections in INP file #802

Closed YuChunTsao closed 2 weeks ago

YuChunTsao commented 3 weeks ago

This commit includes the following changes:

These enhancements improve readability and understanding of the INP file.

LRossman commented 3 weeks ago

@YuChunTsao I have two suggestions:

  1. Use two semi-colons (;;)instead of just one to begin each heading line. This will make it easier for an input parser to identify a heading line and not confuse it with a comment.
  2. Change the "Factors" column heading in the [PATTERNS] section to "Multipliers" since that is the term used in the manual and the GUI.
YuChunTsao commented 2 weeks ago

@LRossman

Thank you for your suggestions.

  1. I've added two semicolons at the start of each heading line.
  2. After reviewing the code, I noticed that Multipliers had already been used in the [PATTERNS] section as per commit 317990a8d174ff972bbc22263c1be01306afa911.