Skip to content

Commit

Permalink
Documentation: Fix mentions of reader CardObserver
Browse files Browse the repository at this point in the history
CardObserver is for card movements, not reader movements.
I guess the code for CardMonitoring.py was copy/pasted from
ReaderMonitoring.py and the documentation was left mostly unchanged.

Also changed some "smartcard" in "smart card"
  • Loading branch information
davecahill authored and LudovicRousseau committed Nov 14, 2016
1 parent 7776e55 commit b3350b5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions smartcard/CardMonitoring.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,25 +45,25 @@
class CardObserver(Observer):
"""
CardObserver is a base abstract class for objects that are to be notified
upon smartcard reader insertion/removal.
upon smart card insertion / removal.
"""

def __init__(self):
pass

def update(self, observable, handlers):
"""Called upon reader insertion/removal.
"""Called upon smart card insertion / removal.
@param observable:
@param handlers:
- addedcards: list of added readers causing notification
- removedcards: list of removed readers causing notification
- addedcards: list of inserted smart cards causing notification
- removedcards: list of removed smart cards causing notification
"""
pass


class CardMonitor(object):
"""Class that monitors smart card insertion/removal.
"""Class that monitors smart card insertion / removals.
and notify observers
note: a card monitoring thread will be running
Expand All @@ -77,7 +77,7 @@ class CardMonitor(object):
"""

class __CardMonitorSingleton(Observable):
"""The real smartcard monitor class.
"""The real smart card monitor class.
A single instance of this class is created
by the public CardMonitor class.
Expand Down

0 comments on commit b3350b5

Please sign in to comment.