data

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 10, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package data provides functionality to interact with sources of documentation data.

In the initial phase, these functions are quite... poor. Some degree of effort needs investing to better process the steps necessary to work with Git. There are several steps required that each generate their own errors, care is required.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type State

type State struct {
	// URL denotes the remote for this State.
	Git autodocs.Git

	// Sha contains the current sha checked out.
	Sha string
	// contains filtered or unexported fields
}

State will keep a hold of the current details surrounding the local data repository.

func Prep

func Prep(g autodocs.Git) *State

Prep will setup and begin the data acquisition for a specific repository location.

func (*State) Fetch

func (s *State) Fetch(t time.Time)

Fetch will check for a new sha and pull if one found.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL