Merge pull request #388 from observerly/docs/getCorrectionToHorizontalForRefraction

michealroberts · web-flow · commit 2e1b9ddc4e1f · 2024-10-16T15:58:53.000+01:00
docs: amend doc string in getCorrectionToHorizontalForRefraction in @observerly/astrometry
diff --git a/src/refraction.ts b/src/refraction.ts
@@ -16,9 +16,8 @@ import { convertDegreesToRadians as radians } from './utilities'
  *
  * getCorrectionToHorizontalForRefraction()
  *
- * The eccentricity of the Earth's orbit is a measure of how elliptical the Earth's
- * orbit is. The eccentricity of the Earth's orbit is not constant, but varies over
- * time. This function returns the eccentricity of the Earth's orbit for a given date.
+ * The correct to the HorizontalCoordinate for refraction is an adjustment to the observed
+ * HorizontalCoordinate based on pressure and temperature effects.
  *
  * @param target - The equatorial coordinate of the observed object.
  * @param temperature - The temperature in Kelvin.

Original file line number	Diff line number	Diff line change
`@@ -16,9 +16,8 @@ import { convertDegreesToRadians as radians } from './utilities'`
`16`	`16`	`*`
`17`	`17`	`* getCorrectionToHorizontalForRefraction()`
`18`	`18`	`*`
`19`		`- * The eccentricity of the Earth's orbit is a measure of how elliptical the Earth's`
`20`		`- * orbit is. The eccentricity of the Earth's orbit is not constant, but varies over`
`21`		`- * time. This function returns the eccentricity of the Earth's orbit for a given date.`
	`19`	`+ * The correct to the HorizontalCoordinate for refraction is an adjustment to the observed`
	`20`	`+ * HorizontalCoordinate based on pressure and temperature effects.`
`22`	`21`	`*`
`23`	`22`	`* @param target - The equatorial coordinate of the observed object.`
`24`	`23`	`* @param temperature - The temperature in Kelvin.`