done

Documentation

Overview

Package done provides a single card to display when there is nothing left to study.

Index

• type Card
  • func GetCard() *Card
  • func (c *Card) Action(_ context.Context, _ *int, _ time.Time, _ interface{}) (done bool, err error)
  • func (c *Card) Body(_ context.Context, _ int) (string, error)
  • func (c *Card) BuryRelated() error
  • func (c *Card) Buttons(_ int) (studyview.ButtonMap, error)
  • func (c *Card) DocID() string

Types

type Card

type Card struct{}

Card is a card displaying a "no cards to study" message

func GetCard

func GetCard() *Card

GetCard returns the done card.

func (*Card) Action

func (c *Card) Action(_ context.Context, _ *int, _ time.Time, _ interface{}) (done bool, err error)

Action always returns true, to allow checking for new due cards.

func (*Card) Body

func (c *Card) Body(_ context.Context, _ int) (string, error)

Body returns the Done card body.

func (*Card) BuryRelated

func (c *Card) BuryRelated() error

BuryRelated does nothing

func (*Card) Buttons

func (c *Card) Buttons(_ int) (studyview.ButtonMap, error)

Buttons returns the list of available buttons. As there is only one face for Done cards, the face value is ignored.

func (*Card) DocID

func (c *Card) DocID() string

DocID returns a dummy document ID.