Use backticks to prevent spurious italicization of snake case names

src/InfrastructureSystems.jl

@@ -72,7 +72,7 @@ Optional interface functions:
 
 Subtypes may contain time series. Which requires
 
-  - supports_time_series(::SupplementalAttribute)
+  - `supports_time_series(::SupplementalAttribute)`
 
 All subtypes must include an instance of ComponentUUIDs in order to track
 components attached to each attribute.

src/common.jl

@@ -41,7 +41,7 @@ const CONSTANT = Float64
 const LIM_TOL = 1e-6
 const XY_COORDS = @NamedTuple{x::Float64, y::Float64}
 
-"Delimiter to use when constructing qualified names like component_type__component_name."
+"Delimiter to use when constructing qualified names like `component_type__component_name`."
 const COMPONENT_NAME_DELIMITER = "__"
 
 # See https://github.com/JuliaLang/julia/issues/18485

src/function_data.jl

@@ -358,7 +358,8 @@ deserialize(::Type{FunctionData}, val::Dict) =
 # PowerSimulations.
 
 """
-Get from a subtype or instance of FunctionData the type of data its get_raw_data method returns
+Get from a subtype or instance of FunctionData the type of data its `get_raw_data` method
+returns
 """
 function get_raw_data_type end
 get_raw_data_type(::Union{LinearFunctionData, Type{LinearFunctionData}}) =

src/hdf5_time_series_storage.jl

@@ -35,9 +35,9 @@ Constructs Hdf5TimeSeriesStorage.
   - `create_file::Bool`: create new file
   - `filename=nothing`: if nothing, create a temp file, else use this name.
   - `directory=nothing`: if set and filename is nothing, create a temp file in this
-    directory. If it is not set, use the environment variable SIENNA_TIME_SERIES_DIRECTORY.
-    If that is not set, use tempdir(). This should be set if the time series data is larger
-    than the tmp filesystem can hold.
+    directory. If it is not set, use the environment variable
+    `SIENNA_TIME_SERIES_DIRECTORY`. If that is not set, use tempdir(). This should be set if
+    the time series data is larger than the tmp filesystem can hold.
 """
 function Hdf5TimeSeriesStorage(
     create_file::Bool;

src/system_data.jl

@@ -37,11 +37,11 @@ Construct SystemData to store components and time series data.
 
   - `validation_descriptor_file = nothing`: Optionally, a file defining component validation
     descriptors.
-  - `time_series_in_memory = false`: Controls whether time series data is stored in memory or
-    in a file.
-  - `time_series_directory = nothing`: Controls what directory time series data is stored in.
-    Default is the environment variable SIENNA_TIME_SERIES_DIRECTORY or tempdir() if that
-    isn't set.
+  - `time_series_in_memory = false`: Controls whether time series data is stored in memory
+    or in a file.
+  - `time_series_directory = nothing`: Controls what directory time series data is stored
+    in. Default is the environment variable `SIENNA_TIME_SERIES_DIRECTORY` or `tempdir()` if
+    that isn't set.
   - `compression = CompressionSettings()`: Controls compression of time series data.
 """
 function SystemData(;

src/time_series_cache.jl

@@ -351,7 +351,7 @@ return a TimeSeries.TimeArray of size 1.
   - `component::InfrastructureSystemsComponent`: component
   - `name::AbstractString`: time series name
   - `cache_size_bytes = TIME_SERIES_CACHE_SIZE_BYTES`: maximum size of data to keep in memory
-  - `ignore_scaling_factors = false`: controls whether to ignore scaling_factor_multiplier
+  - `ignore_scaling_factors = false`: controls whether to ignore `scaling_factor_multiplier`
     in the time series instance
 """
 function StaticTimeSeriesCache(

src/time_series_interface.jl

@@ -814,15 +814,15 @@ references.
 
   - `dst::TimeSeriesOwners`: Destination owner
   - `src::TimeSeriesOwners`: Source owner
-  - `name_mapping::Dict = nothing`: Optionally map src names to different dst names.
-    If provided and src has a time_series with a name not present in name_mapping, that
-    time_series will not copied. If name_mapping is nothing then all time_series will be
-    copied with src's names.
+  - `name_mapping::Dict = nothing`: Optionally map src names to different dst names. If
+    provided and src has a `time_series` with a name not present in `name_mapping`, that
+    `time_series` will not copied. If `name_mapping` is nothing then all `time_series` will
+    be copied with src's names.
   - `scaling_factor_multiplier_mapping::Dict = nothing`: Optionally map src multipliers to
-    different dst multipliers.  If provided and src has a time_series with a multiplier not
-    present in scaling_factor_multiplier_mapping, that time_series will not copied. If
-    scaling_factor_multiplier_mapping is nothing then all time_series will be copied with
-    src's multipliers.
+    different dst multipliers.  If provided and src has a `time_series` with a multiplier
+    not present in `scaling_factor_multiplier_mapping`, that `time_series` will not copied.
+    If `scaling_factor_multiplier_mapping` is nothing then all `time_series` will be copied
+    with src's multipliers.
 """
 function copy_time_series!(
     dst::TimeSeriesOwners,

src/time_series_metadata_store.jl

@@ -1057,7 +1057,7 @@ end
 
 """
 Return information about each time series array attached to the owner.
-This information can be used to call get_time_series.
+This information can be used to call `get_time_series`.
 """
 function get_time_series_keys(store::TimeSeriesMetadataStore, owner::TimeSeriesOwners)
     return [make_time_series_key(x) for x in list_metadata(store, owner)]

src/utils/generate_structs.jl

@@ -248,8 +248,8 @@ function generate_structs(
 end
 
 """
-Return true if the structs defined in existing_dir match structs freshly-generated
-from descriptor_file.
+Return true if the structs defined in `existing_dir` match structs freshly generated from
+`descriptor_file`.
 """
 function test_generated_structs(descriptor_file, existing_dir)
     output_dir = mktempdir()