minor updates and fixes to docs #1446
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oskooi
commented
Dec 9, 2020
| Warning: When running a [parallel simulation](Parallel_Meep.md), do *not* call `plot2D` from within an | ||
| `if meep.am_master():` statement since this will cause one of the MPI processes to deadlock. | ||
| Note: When running a [parallel simulation](Parallel_Meep.md), the `plot2D` function expects to be called | ||
| on all processes, but only generates a plot on the master process. |
There was a problem hiding this comment.
Changing the docstrings here should have been followed by executing meep/doc/generate_py_api.py so that the changes also appeared in the markdown page Python_User_Interface.md. This is why 8af7808 was necessary after this PR was merged. There is nothing wrong with readthedocs.io.
bencbartlett
pushed a commit
to bencbartlett/meep
that referenced
this pull request
Sep 9, 2021
* minor updates and fixes to docs * warning for plot2D using meep.am_master() * Update simulation.py Co-authored-by: Steven G. Johnson <stevenj@mit.edu>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
plot2Din Python User Interface/Data Visualization to not use this function in combination withmeep.am_master()plot2Dto Tutorial/GDSII Import/Modes of a Ring Resonator