From 65cb608a985f5168edfa6e2833f37bc812274a2f Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Tue, 9 Feb 2021 11:40:08 -0500 Subject: [PATCH] Update docstrings --- lightcards/deck.py | 4 ++-- lightcards/display.py | 23 +++++++++++++---------- lightcards/progress.py | 5 +++++ lightcards/runner.py | 1 + 4 files changed, 21 insertions(+), 12 deletions(-) diff --git a/lightcards/deck.py b/lightcards/deck.py index 06ed135..f5ad583 100644 --- a/lightcards/deck.py +++ b/lightcards/deck.py @@ -3,7 +3,7 @@ class Card: - """Card extends the list class, and adds ability to star them.""" + """Class containing the card information.""" def __init__(self, inp): self.starred = False @@ -59,7 +59,7 @@ class Card: class Status: - """The status class keeps track of where in the deck the user is""" + """Keeps track of where in the deck the user is""" def __init__(self): self.index = 0 diff --git a/lightcards/display.py b/lightcards/display.py index e0b4f64..133b719 100644 --- a/lightcards/display.py +++ b/lightcards/display.py @@ -17,7 +17,7 @@ class Display: self.obj = obj def run(self, stdscr): - """Set important options before beginning""" + """Set important options that require stdscr before starting""" self.win = stdscr (mlines, mcols) = self.win.getmaxyx() curses.curs_set(0) # Hide cursor @@ -32,13 +32,14 @@ class Display: self.get_key() def panel_create(self, x, y): - """Create popup menus""" + """Create popup panels to a certain scale""" win = curses.newwin(x, y) panel = curses.panel.new_panel(win) win.erase() return (win, panel) def panel_up(self): + """Update panel and window contents""" curses.panel.update_panels() self.win.refresh() @@ -51,7 +52,7 @@ class Display: sys.exit(0) def ntotal(self): - """Get toal number of starred cards""" + """Get total number of starred cards""" return [card for card in self.stack if card.getStar()] def disp_bar(self): @@ -112,7 +113,7 @@ class Display: self.menu_grab() def menu_grab(self): - """Grab keypresses for the menu screen""" + """Grab keypresses on the menu screen""" while True: key = self.win.getkey() if key in ["r", "q", "m"]: @@ -172,6 +173,7 @@ class Display: self.get_key() def menu_init(self, quit=True): + """Initialize the menu with content""" (self.menu_win, self.menu_panel) = self.panel_create(17, 44) self.menu_panel.top() self.menu_panel.hide() @@ -205,8 +207,8 @@ class Display: def disp_menu(self, keygrab=True): """ - Display a menu once the end of the deck has been reached, offering - multiple options on how to continue. + Display a menu offering multiple options on how to manipulate the deck + and to continue """ (mlines, mcols) = self.win.getmaxyx() self.menu_win.mvwin(int(mlines / 2) - 9, int(mcols / 2) - 22) @@ -217,7 +219,7 @@ class Display: self.menu_grab() def wrap_width(self): - """Calculate the width at which the body should wrap""" + """Calculate the width at which the body text should wrap""" (_, mcols) = self.win.getmaxyx() wrap_width = mcols - 20 if wrap_width > 80: @@ -226,7 +228,7 @@ class Display: def disp_card(self): """ - Display the contents of the card + Display the contents of the card. Shows a header, a horizontal line, and the contents of the current side. """ @@ -281,7 +283,7 @@ class Display: self.win.hline(mlines - 2, 0, 0, mcols) def help_init(self): - """Display help screen""" + """Initialize help screen""" (self.help_win, self.help_panel) = self.panel_create(20, 52) self.help_panel.top() self.help_panel.hide() @@ -316,6 +318,7 @@ class Display: self.help_win.box() def disp_help(self): + """Display help screen""" (mlines, mcols) = self.win.getmaxyx() self.help_win.mvwin(int(mlines / 2) - 10, int(mcols / 2) - 26) self.panel_up() @@ -327,6 +330,7 @@ class Display: self.get_key() def current_card(self): + """Get current card object""" return self.stack[self.obj.getIdx()] def get_key(self): @@ -334,7 +338,6 @@ class Display: Display a card and wait for the input. Used as a general way of getting back into the card flow from a menu """ - self.disp_card() while True: key = self.win.getkey() diff --git a/lightcards/progress.py b/lightcards/progress.py index bf78e01..297895d 100644 --- a/lightcards/progress.py +++ b/lightcards/progress.py @@ -11,23 +11,27 @@ dired = f"{os.path.expanduser('~')}/.cache/lightcards/" def name_gen(stra): + """Generate hash of stack for name of pickle file""" hasher = hashlib.md5() hasher.update(str(stra).encode("utf-8")) return hasher.hexdigest() def make_dirs(dired): + """mkdir -p equivalent""" if not os.path.exists(dired): os.makedirs(dired) def dump(obj, stra): + """Write pickle file""" make_dirs(dired) pickle.dump(obj, open(f"{dired}/{name_gen(stra)}.p", "wb")) def dive(stra): + """Get pickle file""" file = f"{dired}/{name_gen(stra)}.p" make_dirs(dired) if os.path.exists(file): @@ -37,6 +41,7 @@ def dive(stra): def purge(stra): + """Delete pickle file""" file = f"{dired}/{name_gen(stra)}/" if os.path.exists(file): shutil.rmtree(file) diff --git a/lightcards/runner.py b/lightcards/runner.py index 2fa42f4..83a71b0 100644 --- a/lightcards/runner.py +++ b/lightcards/runner.py @@ -13,6 +13,7 @@ from .deck import Status def parse_args(): + """Parse command line arguments""" parser = argparse.ArgumentParser( description="Terminal flashcards from Markdown" ) -- 2.39.2