Fix doc, add TagBot [skip ci]

JuliaAstroSim · Apr 21, 2021 · 50ddd37 · 50ddd37 · islent · Apr 21, 2021
1 parent a2ea4fd
commit 50ddd37
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 3 deletions.
diff --git a/.github/workflows/TagBot.yml b/.github/workflows/TagBot.yml
@@ -0,0 +1,15 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/src/Constants.jl b/src/Constants.jl
@@ -81,6 +81,11 @@ function Constant(::Nothing, units)
     return Constant(nothing, Constant(units))
 end
 
+"""
+    Constant(::Type{BigFloat}, units::Vector{Unitful.FreeUnits{N, D, nothing} where D where N})
+
+Construct an immutable struct storing basic physical constants in `BigFloat` corresponding to `units` (default is `uAstro`).
+"""
 function Constant(::Type{BigFloat}, units::Vector{Unitful.FreeUnits{N, D, nothing} where D where N})
     println("Constructing BigFloat constants")
     return Constant(
@@ -98,6 +103,11 @@ function Constant(::Type{BigFloat}, units::Vector{Unitful.FreeUnits{N, D, nothin
     )
 end
 
+"""
+    Constant(::Type{Measurement}, units::Vector{Unitful.FreeUnits{N, D, nothing} where D where N})
+
+Construct an immutable struct storing basic physical constants in `Measurement` corresponding to `units` (default is `uAstro`).
+"""
 function Constant(::Type{Measurement}, units::Vector{Unitful.FreeUnits{N, D, nothing} where D where N})
     println("Constructing Unitless Measurement constants")
     return Constant(

diff --git a/src/Unit.jl b/src/Unit.jl
@@ -416,15 +416,16 @@ end
     function ZeroValue(::Nothing)
     function ZeroValue(units::Vector{Unitful.FreeUnits{N, D, nothing} where D where N} = uAstro)
 
-    Construct an immutable struct providing zero values in corresponding `units` (default is `uAstro`).
-    Useful for accumulated summation, array initialization, etc.
+Construct an immutable struct providing zero `Measurement` values in corresponding `units` (default is `uAstro`).
+Useful for accumulated summation, array initialization, etc.
 
 # Examples
-
+```
 ZeroValue(nothing)
 ZeroValue()
 ZeroValue(uSI)
 ZeroValue(uCGS)
+```
 """
 function ZeroValue(::Nothing)
     return ZeroValue(0.0, PVector(), PVector(), PVector(), 0.0, 0.0, 0.0)
@@ -442,6 +443,19 @@ function ZeroValue(units::Vector{Unitful.FreeUnits{N, D, nothing} where D where
     )
 end
 
+"""
+    ZeroValue(::Type{Measurement}, args...)
+
+Construct an immutable struct providing zero values in corresponding `units` (default is `uAstro`).
+
+# Examples
+```jl
+ZeroValue(Measurement, nothing)
+ZeroValue(Measurement, )
+ZeroValue(Measurement, uSI)
+ZeroValue(Measurement, uCGS)
+```
+"""
 function ZeroValue(::Type{Measurement}, args...)
     z = ZeroValue(args...)
     return ZeroValue(measurement.([getfield(z, i) for i in fieldnames(ZeroValue)])...)