Skip to content

docs: explain phase-shifting transformers with GenericBranch - #1485

Merged
mgovers merged 1 commit into
PowerGridModel:mainfrom
nightcityblade:fix/issue-1484
Jul 27, 2026
Merged

docs: explain phase-shifting transformers with GenericBranch#1485
mgovers merged 1 commit into
PowerGridModel:mainfrom
nightcityblade:fix/issue-1484

Conversation

@nightcityblade

Copy link
Copy Markdown
Contributor

Fixes #1484

Summary

  • document how generic_branch parameters map to a static phase-shifting transformer
  • include a finite-reactance lossless example
  • warn that an impedance-free ideal phase link is singular in the branch model

Testing

  • PATH=/Users/shensheng/.nvm/versions/node/v24.18.0/bin:$PATH uv run --frozen --group lint pre-commit run markdownlint --files docs/user_manual/components.md
  • git diff --check

The full Sphinx build could not reach the changed page locally because the generated Doxygen XML (docs/doxygen/build/xml/index.xml) is absent and Doxygen is not installed in this environment.

@mgovers mgovers added the documentation Improvements or additions to documentation label Jul 23, 2026

@mgovers mgovers left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nightcityblade,

Thank you for your contribution! I only have one minor comment. After you've resolved that, I will kick off CI.

Comment thread docs/user_manual/components.md Outdated

@mgovers mgovers left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nightcityblade,

Thank you for the edit. The code looks good but I see that you do not have verified commits set up (see also https://power-grid-model.readthedocs.io/en/stable/contribution/CONTRIBUTING.html#commit-signature-verification). After you have done that (your commit should have a verified badge next to it) then this is good to go

@nightcityblade

Copy link
Copy Markdown
Contributor Author

Thanks for catching the signature requirement. The requested documentation move is complete and the content checks pass; the remaining blocker is replacing the branch commit with a cryptographically signed commit that GitHub marks Verified.

@TonyXiang8787

Copy link
Copy Markdown
Member

Hi @nightcityblade,

Thanks for your effort. For signed commits, you need to rebase your branch with signed (GPG or SSH) commits, then force push to this PR.

@scud-soptim

Copy link
Copy Markdown
Contributor

I added also a PR for this Request

Signed-off-by: nightcityblade <nightcityblade@gmail.com>
Signed-off-by: nightcityblade <jackchen@haloailabs.com>
@TonyXiang8787

Copy link
Copy Markdown
Member

Hi @nightcityblade,

I see you have closed this PR. Do you still intend to contribute the changes?

@nightcityblade

Copy link
Copy Markdown
Contributor Author

Thanks for the guidance. I rewrote the branch with GitHub-verified signed commit c7e9b5f. It has the exact same Git tree as the previously tested commit, so the documentation content is unchanged; CI has been retriggered.

@mgovers
mgovers added this pull request to the merge queue Jul 27, 2026
@mgovers

mgovers commented Jul 27, 2026

Copy link
Copy Markdown
Member

Hi @nightcityblade,

This PR looks good. Thank you for the contribution!

Note that #1491 was also created to document the PST, but since this PR was first and in a good state, we give this one precedence. After this is merged, these docs can be extended with contents from the other PR, but that is out of scope of this PR.

Sent to merge queue 👍

Merged via the queue into PowerGridModel:main with commit 27d7bb0 Jul 27, 2026
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[IMPROVEMENT] Improve documentation on how to use GenericBranch for Phase Shifting Transformer

4 participants