From 75d22aacee41c547c1debd5fe4919ba5252ff6d8 Mon Sep 17 00:00:00 2001 From: Kevin Lyda <kevin@lyda.ie> Date: Tue, 27 May 2025 19:53:00 +0100 Subject: [PATCH] Update module docs --- editor/tview.go | 10 +++++++++- folders/folders.go | 8 +++++++- folders/verify.go | 1 - pager/pager.go | 3 +++ users/users.go | 2 +- 5 files changed, 20 insertions(+), 4 deletions(-) diff --git a/editor/tview.go b/editor/tview.go index cd6346b..37d8be9 100644 --- a/editor/tview.go +++ b/editor/tview.go @@ -1,4 +1,12 @@ -// Package editor provides a simple editor. +/* +Package editor provides a simple editor. + +This is implemented with [github.com/gdamore/tcell] and +[github.com/rivo/tview]. It would be good to make this work more like EDT. + +In addition, it might be an idea to offer a set of editors that work +like EDT, nano, vi and emacs and allow users to set a preference. +*/ package editor import ( diff --git a/folders/folders.go b/folders/folders.go index 1317b10..2b907ef 100644 --- a/folders/folders.go +++ b/folders/folders.go @@ -1,4 +1,10 @@ -// Package folders are all the routines and sql for managing folders. +/* +Package folders have higher level routines for working with the +[storage] routines. + +This module should likely be stripped down to some routines for verifying +things about folders. The storage specific bits should go to [storage]. +*/ package folders import ( diff --git a/folders/verify.go b/folders/verify.go index ab28a6a..5c4297f 100644 --- a/folders/verify.go +++ b/folders/verify.go @@ -1,4 +1,3 @@ -// Package folders are all the routines and sql for managing folders. package folders import "unicode" diff --git a/pager/pager.go b/pager/pager.go index 79ddd9e..5c1e456 100644 --- a/pager/pager.go +++ b/pager/pager.go @@ -1,6 +1,9 @@ /* Package pager implements the pager. This is used for any large block of text that bulletin needs to show. + +This is very unix specific. Using something like [github.com/gdamore/tcell] +would be more portable. */ package pager diff --git a/users/users.go b/users/users.go index bf3da42..d8ac1c8 100644 --- a/users/users.go +++ b/users/users.go @@ -1,4 +1,4 @@ -// Package users manages users. +// Package users has routines for verifying things about users. package users import ( -- GitLab