Skip to content

Commit 18bd5c8

Browse files
authored
Merge pull request #11 from JuliaAstro/update-docs-and-improvements
Update docs
2 parents c1a6e61 + af9009e commit 18bd5c8

File tree

4 files changed

+11
-10
lines changed

4 files changed

+11
-10
lines changed

docs/src/contributing.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,18 @@ Be polite and respectful.
99
## Bug reports and discussions
1010

1111
If you think you found a bug, feel free to open an [issue](https://github.com/JuliaAstro/SolarPosition.jl/issues).
12+
1213
Focused suggestions and requests can also be opened as issues.
13-
Before opening a pull request, start an issue or a discussion on the topic, please.
14+
15+
!!! info
16+
Before opening a pull request, it can be productive to first start an issue or a
17+
discussion on the topic so that the maintainers and community can provide feedback.
1418

1519
## Working on an issue
1620

17-
If you found an issue that interests you, comment on that issue what your plans are.
18-
If the solution to the issue is clear, you can immediately create a pull request (see below).
19-
Otherwise, say what your proposed solution is and wait for a discussion around it.
21+
If you found an issue that interests you, comment on that issue what your plans are. If
22+
the solution to the issue is clear, you can immediately create a pull request (see below
23+
). Otherwise, say what your proposed solution is and wait for a discussion around it.
2024

2125
!!! tip
2226
Feel free to ping us after a few days if there are no responses.

docs/src/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ CurrentModule = SolarPosition
66

77
## SolarPosition.jl
88

9-
[![Development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaastro.org/SolarPosition.jl/dev/)
109
[![Test workflow status](https://github.com/JuliaAstro/SolarPosition.jl/actions/workflows/Test.yml/badge.svg?branch=main)](https://github.com/JuliaAstro/SolarPosition.jl/actions/workflows/Test.yml?query=branch%3Amain)
1110
[![Coverage](https://codecov.io/gh/JuliaAstro/SolarPosition.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaAstro/SolarPosition.jl)
1211
[![Lint workflow Status](https://github.com/JuliaAstro/SolarPosition.jl/actions/workflows/Lint.yml/badge.svg?branch=main)](https://github.com/JuliaAstro/SolarPosition.jl/actions/workflows/Lint.yml?query=branch%3Amain)

src/Positioning/Positioning.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ refraction corrections.
2222
module Positioning
2323

2424
using Dates: datetime2julian, DateTime, Date, daysinmonth, dayofyear
25-
using Dates: year, month, day, hour, minute, second
25+
using Dates: year, month, day, hour, minute, second, millisecond
2626
using TimeZones: ZonedDateTime, UTC
2727
using StructArrays: StructArrays
2828
using Tables: Tables

src/Positioning/utils.jl

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
"""Utility functions to be used across solar positioning algorithms."""
22

3-
# wrap angle to [-π, π]
4-
@inline wrapπ(x::T) where {T} = ifelse(x > π, x - 2π, ifelse(x < -π, x + 2π, x))
5-
63
# degree helpers
74
deg2rad(x::Real) = float(x) */ 180)
85
rad2deg(x::Real) = float(x) * (180 / π)
96

107
# fractional hour helper
11-
fractional_hour(dt::DateTime) = hour(dt) + minute(dt) / 60 + second(dt) / 3600
8+
fractional_hour(dt::DateTime) =
9+
(hour(dt) + minute(dt) / 60.0 + second(dt) / 3600.0 + millisecond(dt) / 3.6e6)
1210

1311
# constants
1412
const EMR = 6371.01 # Earth Mean Radius in km

0 commit comments

Comments
 (0)