adressed PR suggestions

Author: ZohairZaidi

vpr/src/base/atom_netlist.cpp

@@ -141,7 +141,7 @@ AtomBlockId AtomNetlist::create_block(const std::string& name, const t_model* mo
     AtomBlockId blk_id = Netlist::create_block(name);
 
     //Initialize the data
-    // Use insert instead of push_back
+    // Push back new data or overwrite existing data 
     block_models_.insert(blk_id, model);
     block_truth_tables_.insert(blk_id, truth_table);
 
@@ -175,7 +175,7 @@ AtomPortId AtomNetlist::create_port(const AtomBlockId blk_id, const t_model_port
     if (!port_id) {
         port_id = Netlist::create_port(blk_id, model_port->name, model_port->size, type);
 
-        // Use insert instead of push_back
+        // Push back new data or overwrite existing data 
         port_models_.insert(port_id, model_port);
         associate_port_with_block(port_id, port_type(port_id), blk_id);
     }

vpr/src/base/atom_netlist.h

@@ -165,7 +165,7 @@ class AtomNetlist : public Netlist<AtomBlockId, AtomPortId, AtomPinId, AtomNetId
      */
 
     /**
-     * @brief Create or return an existing block in the netlist
+     * @brief Create or return an existing block in the netlist. If the block already exists, its associated data (model and truth table) will be overwritten.
      *
      *   @param name          The unique name of the block
      *   @param model         The primitive type of the block
@@ -176,15 +176,15 @@ class AtomNetlist : public Netlist<AtomBlockId, AtomPortId, AtomPinId, AtomNetId
     AtomBlockId create_block(const std::string& name, const t_model* model, const TruthTable& truth_table = TruthTable());
 
     /**
-     * @brief Create or return an existing port in the netlist
+     * @brief Create or return an existing port in the netlist. If the port already exists, its associated data (model) will be overwritten.
      *
      *   @param blk_id      The block the port is associated with
      *   @param model_port  The model port the port is associated with
      */
     AtomPortId create_port(const AtomBlockId blk_id, const t_model_ports* model_port);
 
     /**
-     * @brief Create or return an existing pin in the netlist
+     * @brief Create or return an existing pin in the netlist.
      *
      *   @param port_id    The port this pin is associated with
      *   @param port_bit   The bit index of the pin in the port

vpr/src/base/clustered_netlist.cpp

@@ -107,6 +107,7 @@ ClusterBlockId ClusteredNetlist::create_block(const char* name, t_pb* pb, t_logi
     if (blk_id == ClusterBlockId::INVALID()) {
         blk_id = Netlist::create_block(name);
 
+        // Push back new data or overwrite existing data
         block_pbs_.insert(blk_id, pb);
         block_types_.insert(blk_id, type);
 
@@ -144,7 +145,7 @@ ClusterPortId ClusteredNetlist::create_port(const ClusterBlockId blk_id, const s
 ClusterPinId ClusteredNetlist::create_pin(const ClusterPortId port_id, BitIndex port_bit, const ClusterNetId net_id, const PinType pin_type_, int pin_index, bool is_const) {
     ClusterPinId pin_id = Netlist::create_pin(port_id, port_bit, net_id, pin_type_, is_const);
 
-    // insert
+    // Push back new data or overwrite existing data
     pin_logical_index_.insert(pin_id, pin_index); 
 
     ClusterBlockId block_id = port_block(port_id);

vpr/src/base/clustered_netlist.h

@@ -175,7 +175,7 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi
 
   public: //Public Mutators
     /**
-     * @brief Create or return an existing block in the netlist
+     * @brief Create or return an existing block in the netlist. If the block already exists, its associated data (physical block, type, and logical pins) will be overwritten.
      *
      *   @param name   The unique name of the block
      *   @param pb     The physical representation of the block
@@ -184,7 +184,7 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi
     ClusterBlockId create_block(const char* name, t_pb* pb, t_logical_block_type_ptr type);
 
     /**
-     * @brief Create or return an existing port in the netlist
+     * @brief Create or return an existing port in the netlist.
      *
      *   @param blk_id   The block the port is associated with
      *   @param name     The name of the port (must match the name of a port in the block's model)
@@ -193,7 +193,8 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi
      */
     ClusterPortId create_port(const ClusterBlockId blk_id, const std::string& name, BitIndex width, PortType type);
     /**
-     * @brief Create or return an existing pin in the netlist
+     * @brief Create or return an existing pin in the netlist. If the pin already exists, its associated data (logical index) will be overwritten.
+ *
      *
      *   @param port_id    The port this pin is associated with
      *   @param port_bit   The bit index of the pin in the port