comments to be nice with future-self

src/exabgp/bgp/neighbor.py

@@ -472,6 +472,7 @@ def ip_self(self, afi):
             % (afi, self['local-address'].afi)
         )
 
+    # NOTE: this may very well modify the change object passed to the function
     def remove_self(self, change):
         if not change.nlri.nexthop.SELF:
             return change

src/exabgp/configuration/configuration.py

@@ -64,6 +64,7 @@ def inject_change(self, peers, change):
             if neighbor_name in peers:
                 neighbor = self.neighbors[neighbor_name]
                 if change.nlri.family() in neighbor.families():
+                    # remove_self may well have side effects on change
                     neighbor.rib.outgoing.add_to_rib(neighbor.remove_self(change))
                 else:
                     log.error('the route family is not configured on neighbor', 'configuration')

src/exabgp/configuration/neighbor/__init__.py

@@ -238,23 +238,27 @@ def _post_routes(self, neighbor, local):
 
         neighbor.changes = []
         for change in self.scope.pop_routes():
+            # remove_self may well have side effects on change
             neighbor.changes.append(neighbor.remove_self(change))
 
         # old format
         for section in ('static', 'l2vpn', 'flow'):
             routes = local.get(section, {}).get('routes', [])
             for route in routes:
                 route.nlri.action = Action.ANNOUNCE
+                # remove_self may well have side effects on change
                 neighbor.changes.append(neighbor.remove_self(route))
 
         routes = local.get('routes', [])
         for route in routes:
             route.nlri.action = Action.ANNOUNCE
+            # remove_self may well have side effects on change
             neighbor.changes.append(neighbor.remove_self(route))
 
     def _init_neighbor(self, neighbor, local):
         families = neighbor.families()
         for change in neighbor.changes:
+            # remove_self may well have side effects on change
             change = neighbor.remove_self(change)
             if change.nlri.family() in families:
                 # This add the family to neighbor.families()