Browse Source

[2930] Replace example for a more obvious one

Michal 'vorner' Vaner 12 years ago
parent
commit
e8a9043a25
2 changed files with 8 additions and 6 deletions
  1. 4 3
      src/lib/config/ccsession.h
  2. 4 3
      src/lib/python/isc/config/ccsession.py

+ 4 - 3
src/lib/config/ccsession.h

@@ -440,10 +440,11 @@ public:
     ///     users should receive the notification. Only the users that
     ///     subscribed to notifications on the same group receive it.
     /// \param name The name of the event to notify about (for example
-    ///     `config_changed`).
+    ///     `new_group_member`).
     /// \param params Other parameters that describe the event. This might
-    ///     be, for example, the new configuration value. This can be any
-    ///     data element, but it is common for it to be map.
+    ///     be, for example, the ID of the new member and the name of the
+    ///     group. This can be any data element, but it is common for it to be
+    ///     map.
     void notify(const std::string& notification_group,
                 const std::string& name,
                 const isc::data::ConstElementPtr& params =

+ 4 - 3
src/lib/python/isc/config/ccsession.py

@@ -556,10 +556,11 @@ class ModuleCCSession(ConfigData):
           what users should receive the notification. Only users that
           subscribed to notifications on the same group receive it.
         - event_name (string): The name of the event to notify about (for
-          example `config_changed`).
+          example `new_group_member`).
         - params: Other parameters that describe the event. This might be, for
-          example, the new configuration value. This can be any data that can
-          be sent over the isc.cc.Session, but it is common for it to be dict.
+          example, the ID of the new member and the name of the group. This can
+          be any data that can be sent over the isc.cc.Session, but it is
+          common for it to be dict.
         Returns: Nothing
         """
         notification = [event_name]