added docstring for plot_avg_density_2D #212
Open
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
maolinml
requested changes
Nov 23, 2022
There was a problem hiding this comment.
The docstring is very detailed but maybe a bit too complicated. In particular, I still don't quite get the interplay of the arguments. I would suggest to a) simply the docstring a bit (maybe max two sentences per arguments), and b) give one or two examples for the possible combinations of the inputs?
| across all batches in a parallel job, in which case batch_mapping must be supplied and additional | ||
| calculations necessary beyond get_avg_density(). | ||
| register (AtomArrangement): The register used in creating the Hamiltonian | ||
| with_labels (Bool): Choose if each atom's index is displayed. If a batch_mapping is supplied, the order of |
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.
Reimplements docstring for
plot_avg_density_2Dinahs_utils.pyfrom #211