package/gonum
1
0
Fork 0
mirror of https://github.com/gonum/gonum.git synced 2025-10-14 19:26:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

all: fix up missing or malformatted package doc comments

Browse Source
This commit is contained in:
Dan Kortschak
2018-06-07 14:07:56 +09:30
committed by Dan Kortschak
parent 14efad756b
commit 9b6dcf36f0
13 changed files with 56 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
blas/gonum/doc.go
View File

@@ -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.

2
fourier/doc.go
View File

@@ -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"

7
fourier/internal/fftpack/doc.go Normal file
View File

@@ -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"

6
graph/formats/dot/internal/errors/doc.go Normal file
View File

@@ -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"

6
graph/formats/dot/internal/lexer/doc.go Normal file
View File

@@ -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"

6
graph/formats/dot/internal/parser/doc.go Normal file
View File

@@ -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"

6
graph/formats/dot/internal/token/doc.go Normal file
View File

@@ -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"

6
graph/formats/dot/internal/util/doc.go Normal file
View File

@@ -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"

7
graph/path/internal/testgraphs/doc.go Normal file
View File

@@ -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"

6
lapack/doc.go Normal file
View File

@@ -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"

2
lapack/lapack.go
View File

@@ -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"

2
mathext/internal/amos/doc.go
View File

@@ -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"

4
mathext/internal/gonum/doc.go
View File

@@ -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"