GitHub

Clean Up General Formatting

These recommendations are to make navigating our documentation effortless for users, while addressing common markdown formatting issues in the existing Sienna documentation:

Format in back-ticks

All package names, types, functions, methods, and parameters, etc. should formatted in back-ticks:

Do
`max_active_power`

compiles as max_active_power

Don't
max_active_power

compiles as maxactivepower

All types, function, and methods should have hyperlinks to the correct docstring, accounting for multiple methods of the same name due to Julia's multiple dispatch. Documenter.jl will link to the first occurrance in documentation. If that's not the one you're referring to, copy the entire signature with types into the hyperlink reference.

Do
[`get_time_series_values`](@ref)

Or

[`get_time_series_values` from a `ForecastCache`](@ref get_time_series_values(
owner::TimeSeriesOwners,
forecast::Forecast,
start_time::Dates.DateTime;
len::Union{Nothing, Int} = nothing,
ignore_scaling_factors = false,
))
Don't
`get_time_series_values`

Or

get_time_series_values
Do

Define hyperlinks to other packages with an @extref reference, rather than hard-coded references which might change, using DocumenterInterLinks.jl:

[`PowerSystems.System`](@extref)

compiles as PowerSystems.System. See Declaring External Projects for help setting up a connection to a new package for the first time.

All other Sienna package names should have documentation (not Git repo) hyperlinks:

Do

[`PowerSystems.jl`](https://nrel-sienna.github.io/PowerSystems.jl/stable/)

Don't
`PowerSystems.jl`

Or

PSY

Or

[`PowerSystems.jl`](https://github.com/NREL-Sienna/PowerSystems.jl)