Documenting that expandTo conserves mass not number of atoms - #2645
Open
john-science wants to merge 1 commit into
Open
Documenting that expandTo conserves mass not number of atoms#2645john-science wants to merge 1 commit into
john-science wants to merge 1 commit into
Conversation
This file contains hidden or 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
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.
What is the change? Why is it being made?
There was some confusion that using the
expandTofeature in thenuclide flagssection of the blueprints does not conserve the number of atoms. But that is because it conserves the total most of the element instead. (And you can only do one.)Now, this was mentioned in a docstring somewhere, but the request was made to warn people in the documentation. Which is fair, and this PR accomplishes that.
close #1817
SCR Information
Change Type: fixes
One-Sentence Rationale: People should know what kind is conserved when they use the expandTo feature in nuclide flags.
One-line Impact on Requirements: NA
Checklist
docfolder.pyproject.toml.