Skip to content

Commit 5102306

Browse files
icweavericweaver
committed
chore: Update docstrings
1 parent 059195c commit 5102306

244 files changed

Lines changed: 560 additions & 542 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/a2af.jl‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ Status: vector/matrix support function.
1414
- `sign::Char` '+' or '-'
1515
- `idmsf::Vector{Int32}` degrees, arcminutes, arcseconds, fraction
1616
17-
Called:
18-
iauD2tf decompose days to hms
19-
2017
### Notes
2118
1. The argument ndp is interpreted as follows:
2219
| ndp | resolution |
@@ -39,9 +36,14 @@ Called:
3936
4037
3. The absolute value of angle may exceed 2pi. In cases where it does not, it is up to the caller to test for and handle the case where angle is very nearly 2pi and rounds up to 360 degrees, by testing for idmsf[0]=360 and setting idmsf[0-3] to zero.
4138
42-
This revision: 2013 June 18
39+
Called:
40+
iauD2tf decompose days to hms
41+
42+
This revision: 2020 April 1
43+
44+
SOFA release 2020-07-21
4345
44-
SOFA release 2018-01-30
46+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
4547
"""
4648
function iauA2af(ndp::Int, angle::Real)
4749
sign = Vector{UInt8}(undef, 1)

‎src/a2tf.jl‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,9 @@ Status: vector/matrix support function.
1212
angle double angle in radians
1313
1414
### Returned
15-
sign char '+' or '-'
15+
sign char* '+' or '-'
1616
ihmsf int[4] hours, minutes, seconds, fraction
1717
18-
### Called
19-
iauD2tf decompose days to hms
20-
2118
### Notes
2219
2320
1. The argument ndp is interpreted as follows:
@@ -50,11 +47,14 @@ Status: vector/matrix support function.
5047
case where angle is very nearly 2pi and rounds up to 24 hours,
5148
by testing for ihmsf[1]=24 and setting ihmsf[1:4] to zero.
5249
53-
This revision: 2013 July 31
50+
### Called
51+
iauD2tf decompose days to hms
52+
53+
This revision: 2020 April 1
5454
55-
SOFA release 2018-01-30
55+
SOFA release 2020-07-21
5656
57-
Copyright (C) 2018 IAU SOFA Board. See notes at end.
57+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
5858
"""
5959
function iauA2tf(ndp::Int, angle::Real)
6060
sign = Vector{UInt8}(undef, 1)

‎src/ab.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Called:
4444
4545
This revision: 2013 October 9
4646
47-
SOFA release 2018-01-30
47+
SOFA release 2020-07-21
4848
49-
Copyright (C) 2018 IAU SOFA Board. See notes at end.
49+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
5050
"""
5151
function iauAb(pnat::AbstractVector{<:Real}, v::AbstractVector{<:Real}, s::Real, bm1::Float64)
5252
ppr = zeros(Float64, 3)

‎src/ae2hd.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ to hour angle and declination.
5050
5151
Last revision: 2017 September 12
5252
53-
SOFA release 2018-01-30
53+
SOFA release 2020-07-21
5454
55-
Copyright (C) 2018 IAU SOFA Board. See notes at end.
55+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
5656
"""
5757
function iauAe2hd(az::Real, el::Real, phi::Real)
5858
ha = zeros(Float64, 1)

‎src/af2a.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Returned (function value):
3232
3333
This revision: 2013 June 18
3434
35-
SOFA release 2018-01-30
35+
SOFA release 2020-07-21
3636
37-
Copyright (C) 2018 IAU SOFA Board. See notes at end.
37+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
3838
"""
3939
function iauAf2a(sign::Char, ideg::Int, iamin::Int, asec::Real)
4040
rad = zeros(Float64, 1)

‎src/anp.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Returned (function value):
1515
1616
This revision: 2013 June 18
1717
18-
SOFA release 2018-01-30
18+
SOFA release 2020-07-21
1919
20-
Copyright (C) 2018 IAU SOFA Board. See notes at end.
20+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
2121
"""
2222
function iauAnp(a::Real)
2323
return ccall((:iauAnp, libsofa_c), Cdouble, (Cdouble,), convert(Float64, a))

‎src/anpm.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Returned (function value):
1515
1616
This revision: 2013 June 18
1717
18-
SOFA release 2018-01-30
18+
SOFA release 2020-07-21
1919
20-
Copyright (C) 2018 IAU SOFA Board. See notes at end.
20+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
2121
"""
2222
function iauAnpm(a::Real)
2323
return ccall((:iauAnpm, libsofa_c), Cdouble, (Cdouble,), convert(Float64, a))

‎src/apcg.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,9 @@ Called:
100100
101101
This revision: 2013 October 9
102102
103-
SOFA release 2018-01-30
103+
SOFA release 2020-07-21
104104
105-
Copyright (C) 2018 IAU SOFA Board. See notes at end.
105+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
106106
"""
107107
function iauApcg(date1::Real, date2::Real, ebpv::AbstractMatrix{<:Real}, ehp::AbstractVector{<:Real})
108108
# Allocate return value

‎src/apcg13.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ Status: support function.
105105
106106
This revision: 2013 October 9
107107
108-
SOFA release 2018-01-30
108+
SOFA release 2020-07-21
109109
110-
Copyright (C) 2018 IAU SOFA Board. See notes at end.
110+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
111111
"""
112112
function iauApcg13(date1::Real, date2::Real)
113113
# Allocate return value

‎src/apci.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ Called:
110110
111111
This revision: 2013 September 25
112112
113-
SOFA release 2018-01-30
113+
SOFA release 2020-07-21
114114
115-
Copyright (C) 2018 IAU SOFA Board. See notes at end.
115+
Copyright (C) 2020 IAU SOFA Board. See notes at end.
116116
"""
117117
function iauApci(
118118
date1::Real, date2::Real,

0 commit comments

Comments
 (0)