Skip to content

Update Docs/Citation for power_electronics -- Issue # 216#258

Open
liangXD523 wants to merge 1 commit into
mainfrom
fix/216-power-electronics-citation
Open

Update Docs/Citation for power_electronics -- Issue # 216#258
liangXD523 wants to merge 1 commit into
mainfrom
fix/216-power-electronics-citation

Conversation

@liangXD523

Copy link
Copy Markdown
Contributor

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)
216

Type of change

Please delete options that are not relevant.

  • Documentation only change (no code changed)
  • This change requires a documentation update

Screenshots

Please attach before and after screenshots of the change if applicable.

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files
  • I have run ruff check . and ruff format
  • I have run mypy .
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Reviewer Checklist:

  • The content of this PR brings value to the community. It is not too specific to a particular use case.
  • The tests and checks pass (linting, formatting, type checking). For a new problem, double check the github actions workflow to ensure the problem is being tested.
  • The documentation is updated.
  • The code is understandable and commented. No large code blocks are left unexplained, no huge file. Can I read and understand the code easily?
  • There is no merge conflict.
  • The changes are not breaking the existing results (datasets, training curves, etc.). If they do, is there a good reason for it? And is the associated problem version bumped?
  • For a new problem, has the dataset been generated with our slurm script so we can re-generate it if needed? (This also ensures that the problem is running on the HPC.)
  • For bugfixes, it is a robust fix and not a hacky workaround.

@markfuge

Copy link
Copy Markdown
Member

@liangXD523 can you merge in from the main branch to resolve the CI issues, which should be fixed by #253 ? Also, your single commit message should be updated to use the conventional commits strategy, so that that CI test doesn't trigger.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants