Add docstring

MurrellGroup · Oct 29, 2024 · d0cdb6f · d0cdb6f · AntonOresten · Oct 29, 2024
1 parent d54d614
commit d0cdb6f
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/src/properties.jl b/src/properties.jl
@@ -22,11 +22,22 @@ checkproperty(::Any, ::AbstractProperty) = nothing
 unpack(x) = x
 unpack(p::AbstractProperty) = p.value
 
+"""
+    StandardProperty
+
+    StandardProperty(value)
+
+A property with arbitrary type. The value is retained as is.
+
+This is the default property type for [`addproperties`](@ref).
+
+See also [`IndexableProperty`](@ref).
+"""
 struct StandardProperty{T} <: AbstractProperty
     value::T
 end
 
-Base.getindex(p::AbstractProperty, ::Any) = unpack(p)
+Base.getindex(p::StandardProperty, ::Any) = unpack(p)
 
 """
     IndexableProperty