Update docs with more detail

JuliaEnergy / PowerDynamics.jl

Package for dynamical modeling of power grids

https://juliaenergy.github.io/PowerDynamics.jl/latest/

GNU General Public License v3.0

107 stars 32 forks source link

Update docs with more detail #53

Open SabineAuer opened 5 years ago

SabineAuer commented 5 years ago

explain parameters for line types
self admittance of nodes is not documented, yet
explain functions, e.g inc() for perturbations
update docs for wind turbine generator and renewable generator with inertial response

lindnemi commented 4 years ago

in the current docs most of the "source" links for node and line types, redirect to the julia base github folder, instead of the actual powerdynamics source code

SabineAuer commented 4 years ago

@lindnemi Mhh. I am not sure why this is the case. It is the same in NetworkDynamics since I wanted to check how it might look in a working example repo I looked at NeworkDynamics.

lindnemi commented 4 years ago

Oha. That's right! Thanks for checking!

I have no idea why, but will look into this on the ND side and report back.

lindnemi commented 4 years ago

https://github.com/JuliaDocs/Documenter.jl/issues/1374

lindnemi commented 3 years ago

the source links work, documenter has fixed the issue