diff --git a/blas/gonum/doc.go b/blas/gonum/doc.go index dbe376c4..3f4b6c1d 100644 --- a/blas/gonum/doc.go +++ b/blas/gonum/doc.go @@ -5,7 +5,7 @@ // Ensure changes made to blas/native are reflected in blas/cgo where relevant. /* -Package native is a Go implementation of the BLAS API. This implementation +Package gonum is a Go implementation of the BLAS API. This implementation panics when the input arguments are invalid as per the standard, for example if a vector increment is zero. Note that the treatment of NaN values is not specified, and differs among the BLAS implementations. diff --git a/fourier/doc.go b/fourier/doc.go index 530b9c94..49ac326e 100644 --- a/fourier/doc.go +++ b/fourier/doc.go @@ -2,5 +2,5 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -// Package fourier provides functions to perform fourier transforms. +// Package fourier provides functions to perform Discrete Fourier Transforms. package fourier // import "gonum.org/v1/gonum/fourier" diff --git a/fourier/internal/fftpack/doc.go b/fourier/internal/fftpack/doc.go new file mode 100644 index 00000000..042317c0 --- /dev/null +++ b/fourier/internal/fftpack/doc.go @@ -0,0 +1,7 @@ +// Copyright ©2018 The Gonum Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package fftpack implements Discrete Fourier Transform functions +// ported from the Fortran implementation of FFTPACK. +package fftpack // import "gonum.org/v1/gonum/fourier/internal/fftpack" diff --git a/graph/formats/dot/internal/errors/doc.go b/graph/formats/dot/internal/errors/doc.go new file mode 100644 index 00000000..96062423 --- /dev/null +++ b/graph/formats/dot/internal/errors/doc.go @@ -0,0 +1,6 @@ +// Copyright ©2018 The Gonum Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package error provides generated internal error functions for DOT parsing. +package errors // import "gonum.org/v1/gonum/graph/formats/dot/internal/errors" diff --git a/graph/formats/dot/internal/lexer/doc.go b/graph/formats/dot/internal/lexer/doc.go new file mode 100644 index 00000000..7ba072c9 --- /dev/null +++ b/graph/formats/dot/internal/lexer/doc.go @@ -0,0 +1,6 @@ +// Copyright ©2018 The Gonum Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package lexer provides generated internal lexer functions for DOT parsing. +package lexer // import "gonum.org/v1/gonum/graph/formats/dot/internal/lexer" diff --git a/graph/formats/dot/internal/parser/doc.go b/graph/formats/dot/internal/parser/doc.go new file mode 100644 index 00000000..5954ca2c --- /dev/null +++ b/graph/formats/dot/internal/parser/doc.go @@ -0,0 +1,6 @@ +// Copyright ©2018 The Gonum Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package parser provides generated internal parsing functions for DOT parsing. +package parser // import "gonum.org/v1/gonum/graph/formats/dot/internal/parser" diff --git a/graph/formats/dot/internal/token/doc.go b/graph/formats/dot/internal/token/doc.go new file mode 100644 index 00000000..15a9c161 --- /dev/null +++ b/graph/formats/dot/internal/token/doc.go @@ -0,0 +1,6 @@ +// Copyright ©2018 The Gonum Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package token provides generated internal tokenizing functions for DOT parsing. +package token // import "gonum.org/v1/gonum/graph/formats/dot/internal/token" diff --git a/graph/formats/dot/internal/util/doc.go b/graph/formats/dot/internal/util/doc.go new file mode 100644 index 00000000..a11b3be9 --- /dev/null +++ b/graph/formats/dot/internal/util/doc.go @@ -0,0 +1,6 @@ +// Copyright ©2018 The Gonum Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package util provides generated internal utility functions for DOT parsing. +package util // import "gonum.org/v1/gonum/graph/formats/dot/internal/util" diff --git a/graph/path/internal/testgraphs/doc.go b/graph/path/internal/testgraphs/doc.go new file mode 100644 index 00000000..2845d130 --- /dev/null +++ b/graph/path/internal/testgraphs/doc.go @@ -0,0 +1,7 @@ +// Copyright ©2018 The Gonum Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package testsgraphs provides a number of graphs used for testing +// routines in the path and path/dynamic packages. +package testgraphs // import "gonum.org/v1/gonum/graph/path/internal/testgraphs" diff --git a/lapack/doc.go b/lapack/doc.go new file mode 100644 index 00000000..2475cb4a --- /dev/null +++ b/lapack/doc.go @@ -0,0 +1,6 @@ +// Copyright ©2018 The Gonum Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package lapack provides interfaces for the LAPACK linear algebra standard. +package lapack // import "gonum.org/v1/gonum/lapack" diff --git a/lapack/lapack.go b/lapack/lapack.go index 1532fce4..5029389c 100644 --- a/lapack/lapack.go +++ b/lapack/lapack.go @@ -2,7 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -package lapack // import "gonum.org/v1/gonum/lapack" +package lapack import "gonum.org/v1/gonum/blas" diff --git a/mathext/internal/amos/doc.go b/mathext/internal/amos/doc.go index 44df5db6..32f96c14 100644 --- a/mathext/internal/amos/doc.go +++ b/mathext/internal/amos/doc.go @@ -2,5 +2,5 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -// package amos implements functions originally in the Netlab code by Donald Amos. +// Package amos implements functions originally in the Netlib code by Donald Amos. package amos // import "gonum.org/v1/gonum/mathext/internal/amos" diff --git a/mathext/internal/gonum/doc.go b/mathext/internal/gonum/doc.go index aa07a988..cbe6aa23 100644 --- a/mathext/internal/gonum/doc.go +++ b/mathext/internal/gonum/doc.go @@ -2,6 +2,6 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -// package gonum contains functions implemented by the gonum team. It is here to -// avoid circular imports and/or double coding of functions. +// Package gonum contains functions implemented by the gonum team. +// It is here to avoid circular imports and/or double coding of functions. package gonum // import "gonum.org/v1/gonum/mathext/internal/gonum"