Skip to content

Fixed documentation issues in PowerElectronics - #590

Merged
pelesh merged 3 commits into
developfrom
powerelectronics_documentation
Sep 29, 2026
Merged

pelesh merged 3 commits into
developfrom
powerelectronics_documentation

Conversation

@abdourahmanbarry

Copy link
Copy Markdown
Collaborator

Description

Updated documentation for the PowerElectronics module to address issue #533.

Closes #533

Checklist

  • All tests pass.
  • Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra.
  • The new code follows GridKit™ style guidelines.
  • There are unit tests for the new code.
  • The new code is documented.
  • The feature branch is rebased with respect to the target branch.
  • The CHANGELOG.md has been updated to reflect the changes. If this is a minor PR that is part of a larger fix already included in the file, state so.

@abdourahmanbarry abdourahmanbarry self-assigned this Sep 24, 2026
@abdourahmanbarry abdourahmanbarry added the documentation Improvements or additions to documentation label Sep 24, 2026

@superwhiskers superwhiskers left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

some comments on the first file that i would request on all

Comment thread GridKit/Model/PowerElectronics/DistributedGenerator/README.md Outdated
Comment thread GridKit/Model/PowerElectronics/DistributedGenerator/README.md Outdated

@shakedregev shakedregev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

As far as I can tell, the equations are still not rendering.

@pelesh pelesh mentioned this pull request Sep 29, 2026
4 tasks done
@abdourahmanbarry

Copy link
Copy Markdown
Collaborator Author

As far as I can tell, the equations are still not rendering.

@shakedregev Can you check again? It is rendering locally for me.

Screenshot 2026-09-29 143635

@pelesh

pelesh commented Sep 29, 2026

Copy link
Copy Markdown
Collaborator

Please rebase to develop as it includes the fix to the bug that broke documentation generation.

@abdourahmanbarry
abdourahmanbarry force-pushed the powerelectronics_documentation branch from 6c3e0fd to 30c02c8 Compare September 29, 2026 22:32
@pelesh
pelesh requested a review from shakedregev September 29, 2026 22:57
@pelesh
pelesh merged commit 7af8b19 into develop Sep 29, 2026
6 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.

Documentation improvements for PowerElectronics

4 participants