From 657a76cccb12955acba4cb2383ef35ea624b7b3b Mon Sep 17 00:00:00 2001 From: CodeLingo Bot Date: Thu, 28 Feb 2019 21:31:50 +0000 Subject: [PATCH] Fix function comments based on best practices from Effective Go Signed-off-by: CodeLingo Bot --- v3/elementequinox/elementequinox.go | 2 +- v3/interp/interp.go | 4 ++-- v3/iterate/iterate.go | 2 +- v3/precess/precess.go | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/v3/elementequinox/elementequinox.go b/v3/elementequinox/elementequinox.go index 1b1ad2f..ab0a854 100644 --- a/v3/elementequinox/elementequinox.go +++ b/v3/elementequinox/elementequinox.go @@ -48,7 +48,7 @@ var ( _J = unit.AngleFromDeg(.00651966) ) -// ReduceB1950ToJ2000 reduces orbital elements of a solar system body from +// ReduceB1950FK4ToJ2000FK5 reduces orbital elements of a solar system body from // equinox B1950 in the FK4 system to equinox J2000 in the FK5 system. func ReduceB1950FK4ToJ2000FK5(eFrom, eTo *Elements) *Elements { W := _L + eFrom.Node diff --git a/v3/interp/interp.go b/v3/interp/interp.go index 76df63e..327b0df 100644 --- a/v3/interp/interp.go +++ b/v3/interp/interp.go @@ -163,7 +163,7 @@ func (d *Len3) Extremum() (x, y float64, err error) { return x, y, nil } -// Len3Zero finds a zero of the quadratic function represented by the table. +// Zero finds a zero of the quadratic function represented by the table. // // That is, it returns an x value that yields y=0. // @@ -350,7 +350,7 @@ func (d *Len5) Extremum() (x, y float64, err error) { return x, y, nil } -// Len5Zero finds a zero of the quartic function represented by the table. +// Zero finds a zero of the quartic function represented by the table. // // That is, it returns an x value that yields y=0. // diff --git a/v3/iterate/iterate.go b/v3/iterate/iterate.go index c699088..51b38e2 100644 --- a/v3/iterate/iterate.go +++ b/v3/iterate/iterate.go @@ -33,7 +33,7 @@ func DecimalPlaces(better BetterFunc, start float64, places, maxIterations int) return 0, errors.New("Maximum iterations reached") } -// FullPrecison iterates to (nearly) the full precision of a float64. +// FullPrecision iterates to (nearly) the full precision of a float64. // // To allow for a little bit of floating point jitter, FullPrecision iterates // to 15 significant figures, which is the maximum number of full significant diff --git a/v3/precess/precess.go b/v3/precess/precess.go index 6c7b9ec..4b4bd87 100644 --- a/v3/precess/precess.go +++ b/v3/precess/precess.go @@ -239,7 +239,7 @@ func NewEclipticPrecessor(epochFrom, epochTo float64) *EclipticPrecessor { return p } -// EclipticPrecess precesses coordinates eclFrom, leaving result in eclTo. +// Precess precesses coordinates eclFrom, leaving result in eclTo. // // The same struct may be used for eclFrom and eclTo. // EclTo is returned for convenience.