Skip to content

Commit

Permalink
Improve docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
giordano committed May 25, 2020
1 parent 0c000e3 commit 827429a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
1 change: 0 additions & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7"
PhysicalConstants = "5ad8b20f-a522-5ce9-bfc9-ddf1d5bda6ab"
Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"

[compat]
Expand Down
14 changes: 7 additions & 7 deletions src/PhysicalConstants.jl
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Macro to define a new [`PhysicalConstant`](@ref).
The arguments are:
* `name`: the full name of the constant, this will be the eported name of the constant
* `name`: a symbol with the long name of the constant. This symbol is automatically eported
* `sym`: a non-exported alias for the constant
* `descr`: a description of the constant
* `val`: the numerical `Float64` value of the constant, in the reference units
Expand Down Expand Up @@ -183,7 +183,7 @@ Macro to define a new [`PhysicalConstant`](@ref) derived from another existing `
The arguments are:
* `name`: the full name of the constant, this will be the eported name of the constant
* `name`: a symbol with the long name of the constant. This symbol is automatically eported
* `sym`: a non-exported alias for the constant
* `descr`: a description of the constant
* `val`: the numerical `Float64` value of the constant, in the reference units
Expand Down Expand Up @@ -251,16 +251,16 @@ julia> using PhysicalConstants.CODATA2018: G
julia> G
Newtonian constant of gravitation (G)
Value = 6.67408e-11 m^3 kg^-1 s^-2
Standard uncertainty = 3.1e-15 m^3 kg^-1 s^-2
Relative standard uncertainty = 4.6e-5
Value = 6.6743e-11 m^3 kg^-1 s^-2
Standard uncertainty = 1.5e-15 m^3 kg^-1 s^-2
Relative standard uncertainty = 2.2e-5
Reference = CODATA 2018
julia> float(G)
6.67408e-11 m^3 kg^-1 s^-2
6.6743e-11 m^3 kg^-1 s^-2
julia> float(Float32, G)
6.67408f-11 m^3 kg^-1 s^-2
6.6743f-11 m^3 kg^-1 s^-2
```
"""
float(::PhysicalConstant)
Expand Down

0 comments on commit 827429a

Please sign in to comment.