Skip to content
This repository has been archived by the owner on Sep 4, 2024. It is now read-only.

fixing the node docs #31

Open
timziebart opened this issue Jan 14, 2019 · 6 comments
Open

fixing the node docs #31

timziebart opened this issue Jan 14, 2019 · 6 comments
Assignees
Labels
bug Something isn't working

Comments

@timziebart
Copy link
Member

Hi @SabineAuer ,

could you please fix the docs of the nodes that you implemented. You can locally check the results by running make docs (in the PowerDynamics.jl folder) and the result will be in PowerDynamics.jl/docs/build/index.html.

@timziebart timziebart added the bug Something isn't working label Jan 14, 2019
@SabineAuer
Copy link
Member

SabineAuer commented Feb 8, 2019

I fixed the docs, committed and pushed my changes to branch master (see commit). Can I close this issue now?

@timziebart
Copy link
Member Author

timziebart commented Feb 11, 2019

Please do not push directly to master. Always open a PR, so we can discuss the content before it goes to master. That keeps master working and ensures we don't have a cluttered history.

Hence, please

  1. undo the commit on master (on github)
  2. open a PR with your suggested changes
  3. let's discuss it in the PR then.

SabineAuer added a commit that referenced this issue Feb 27, 2019
* CHANGELOG modified

* more explanation added to docs for node dynamics and naming convention of variables taking into account

* Omega_H removed from keyword arguements

* merged with master 2
@SabineAuer
Copy link
Member

Can we also close this issue now?

@timziebart
Copy link
Member Author

@SabineAuer
Copy link
Member

@timkittel: Can you help me out what exactly you refer to? :)

@timziebart
Copy link
Member Author

They both have the paragraph on ω being a rotor frequency (and there is no rotor) and they miss a reference (if possible a standard book, not a paper).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants