Remove references to rwxrob in docs

This commit is contained in:
rwxrob 2022-04-17 19:26:44 -04:00
parent e3dc6a52db
commit c804f69060
No known key found for this signature in database
GPG Key ID: 2B9111F33082AE77
4 changed files with 15 additions and 17 deletions

View File

@ -10,9 +10,9 @@ package bonzai
//
// The location to which YAML is to be persisted is not specified by
// this interface. Most implementations will use a file in
// os.UserConfigDir (see rwxrob/conf). Implementations may use any
// persistence layer that guarantees atomic OverWrites and can be edited
// with a local system editor.
// os.UserConfigDir. Implementations may use any persistence layer that
// guarantees atomic OverWrites and can be edited with a local system
// editor.
//
// The Id may be anything that can be a YAML key, but use of Unicode
// Letter class runes is strongly recommended. Usually, the id will be
@ -50,12 +50,11 @@ type Configurer interface {
//
// Implementations must persist (cache) simple string key/value
// variables Implementations of Vars can persist in different ways, but
// most will write to os.UserCacheDir (see rwxrob/vars). Files, network
// storage, or cloud databases, etc. are all allowed and expected.
// However, each must always present the data in a .key=val format with
// \r and \n escaped and the key never must contain an equal (=). (Equal
// signs in the value are ignored.) This is the fastest format to read
// and parse.
// most will write to os.UserCacheDir. Files, network storage, or cloud
// databases, etc. are all allowed and expected. However, each must
// always present the data in a .key=val format with \r and \n escaped
// and the key never must contain an equal (=). (Equal signs in the
// value are ignored.) This is the fastest format to read and parse.
type Vars interface {
Init() error // initialize completely new cache
Data() string // k=v with \r and \n escaped in v

View File

@ -70,7 +70,7 @@ var Commands map[string][]any
// Comp may be optionally assigned any implementation of
// bonzai.Completer and will be used as the default if a Command does not
// provide its own. Comp is assigned rwxrob/compcmd.Completer by default.
// provide its own. Comp is assigned compcmd.Completer by default.
// This can be overriden by Bonzai tree developers through simple
// assignment to their own preference. However, for consistency, this
// default is strongly recommended, at least for all branch commands (as
@ -97,7 +97,7 @@ var Conf bonzai.Configurer
// Vars may be optionally assigned any implementation of a bonzai.Vars
// but this is normally assigned at init() time by a bonzai.Vars driver
// module (see rwxrob/vars). Once assigned it should not be reassigned
// module. Once assigned it should not be reassigned
// at any later time during runtime. Certain Bonzai branches and
// commands may require Z.Vars to be defined and those that do generally
// require the same implementation throughout all of runtime. Commands

View File

@ -18,9 +18,8 @@ var IndentBy = 7
// Columns is the number of bytes (not runes) at which Wrap will wrap.
// By default detects the terminal width (if possible) otherwise keeps
// 80 standard (see rwxrob/term.WinSize). Bonzai command tree creator
// can change this for every composite command imported their
// application in this one place.
// 80 standard. Bonzai command tree creator can change this for every
// composite command imported their application in this one place.
var Columns = int(term.WinSize.Col)
// Lines returns the string converted into a slice of lines.
@ -180,7 +179,7 @@ MAIN:
// ***BoldItalic***
// <under> (keeping brackets)
//
// See Mark for block formatting and rwxrob/term for terminal rendering.
// See Mark for block formatting and term for terminal rendering.
func Emph(buf string) string {
var nbuf []rune
var opentok, closetok bool

View File

@ -122,7 +122,7 @@ func ExampleBlocks_verbatim() {
func ExampleEmph_basics() {
// Emph observes the rwxrob/term escapes
// Emph observes the term escapes
// (see package documentation for more)
term.Italic = `<italic>`
@ -355,7 +355,7 @@ func ExampleMarkf() {
func ExamplePrintEmph_basics() {
// Emph observes the rwxrob/term escapes
// Emph observes the term escapes
// (see package documentation for more)
term.Italic = `<italic>`