[vpr][analysis] apply comments

Author: amin1377

vpr/src/analysis/timing_reports.cpp

@@ -197,6 +197,7 @@ void generate_net_timing_report_csv(const std::string& prefix,
     for (const auto& net : atom_netlist.nets()) {
         const auto& net_name = atom_netlist.net_name(net);
         const auto& source_pin = *atom_netlist.net_pins(net).begin();
+        // for the driver/source, this is the worst slack to any fanout.
         auto source_pin_slack = timing_info.setup_pin_slack(source_pin);
         auto tg_source_node = atom_lookup.atom_pin_tnode(source_pin);
         VTR_ASSERT(tg_source_node.is_valid());

vpr/src/base/read_options.cpp

@@ -3089,7 +3089,10 @@ argparse::ArgumentParser create_arg_parser(const std::string& prog_name, t_optio
         .show_in(argparse::ShowIn::HELP_ONLY);
 
     analysis_grp.add_argument<bool, ParseOnOff>(args.generate_net_timing_report, "--generate_net_timing_report")
-        .help("Generates a net timing report for each net in the design.")
+        .help(
+            "Generates a net timing report in CSV format, reporting the delay and slack\n"
+            "for every routed connection in the design.\n"
+            "The report is saved as 'report_net_timing.csv'.")
         .default_value("off")
         .show_in(argparse::ShowIn::HELP_ONLY);