Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Maxwell create_setup docstring, currently referring to HFSS #3970

Closed
IreneWoyna opened this issue Dec 12, 2023 · 2 comments · Fixed by #3985
Closed

Improve Maxwell create_setup docstring, currently referring to HFSS #3970

IreneWoyna opened this issue Dec 12, 2023 · 2 comments · Fixed by #3985
Assignees
Labels
enhancement New features or code improvements

Comments

@IreneWoyna
Copy link
Contributor

Description of the feature

*** this is a demo issue for pyAEDT for Maxwell training **

Replace HFSS by Maxwell in docstring in maxwell.py function create_setup()

Steps for implementing the feature

No response

Useful links and references

No response

@IreneWoyna IreneWoyna added the enhancement New features or code improvements label Dec 12, 2023
@IreneWoyna
Copy link
Contributor Author

image

@gmalinve
Copy link
Contributor

fix code snippet example in :doc:../SetupTemplatesMaxwell

DaveTwyman added a commit that referenced this issue Dec 14, 2023
@DaveTwyman DaveTwyman self-assigned this Dec 14, 2023
DaveTwyman added a commit that referenced this issue Dec 22, 2023
* Fixed Docstring #3970

* Update pyaedt/maxwell.py

Co-authored-by: Maxime Rey <[email protected]>

* Update pyaedt/maxwell.py

Extra Line

Co-authored-by: Samuel Lopez <[email protected]>

* Update pyaedt/maxwell.py

Unneeded Indentation

Co-authored-by: Samuel Lopez <[email protected]>

* Update pyaedt/maxwell.py

Co-authored-by: Samuel Lopez <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update maxwell.py

MIssing Maxwell solver types added

* Update maxwell.py

Spread Maxwell solver names over two lines to obey line length limit

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update pyaedt/maxwell.py

Hi, There was no deep thought behind the dash next to the colon. 
I've removed it, sounds like text will now be consistent with other parts of docs

Co-authored-by: SMoraisAnsys <[email protected]>

* Update pyaedt/maxwell.py

The word 'Depending' was proposed instead of 'Based'

Co-authored-by: Kathy Pippert <[email protected]>

* Update pyaedt/maxwell.py

Solvers no longer grouped in terms of Magnetic and Electric solvers but now alphabetized and with double backticks and quotation marks applied.

Co-authored-by: Kathy Pippert <[email protected]>

* Fixed Docstring #3970 and removed reference to HFSS

* Fixed Docstring #3970 and removed reference to HFSS

* Title style reverted to Sentence-style capitalization.

* fix doc

* fix doc

* Reference to AC and DC Conduction templates removed

* remove blank line

---------

Co-authored-by: Maxime Rey <[email protected]>
Co-authored-by: gmalinve <[email protected]>
Co-authored-by: Samuel Lopez <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: SMoraisAnsys <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Giulia Malinverno <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants