Skip to content

Commit

Permalink
Fix doc name, specify throws in two functions (#110)
Browse files Browse the repository at this point in the history
Reading through and trying to grok some aspects of HEALpix. I discovered one function in nside.jl had an incorrect function and parameter names in the documentation.
  • Loading branch information
robertkleffner authored May 25, 2023
1 parent 1719ebe commit 640832f
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/nside.jl
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ nside2resol(nside::Integer) = sqrt(nside2pixarea(nside))
"""
nside2order(nside::Integer)
Return the order (positive integer) associated with a given NSIDE.
Return the order (positive integer) associated with a given NSIDE. If
the given nside is not valid, throw a `DomainError` exception.
If you have created a [`Healpix.Resolution`](@ref) object, you can
access the order through the field `order`.
Expand All @@ -101,9 +102,10 @@ end


"""
nside2order(nside::Integer)
order2nside(order::Integer)
Return the value of NSIDE for a given order.
Return the value of NSIDE for a given order. If the given order is
not valid, throw a `DomainError` exception.
If you have created a [`Healpix.Resolution`](@ref) object, you can
access the value of NSIDE through the field `nside`.
Expand Down

0 comments on commit 640832f

Please sign in to comment.