Docstring updates: Fix missing Outcar attributes and update elemental_dos_dos string #2293
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.
Summary
The docs for
pymatgen.io.vasp.outputs.Outcar
are missing many of the attributes. For instance, it wasn't clear to me until I read the code that theOutcar()
object has atotal_mag
keyword. I've update the docstring to include the missing attributes.The docs for
pymatgen.electronic_structure.dos.get_element_spd_dos
have an incorrect description of theReturns
dictionary. This has been updated. Note: There are still some aesthetic issues with the docs, as mentioned in Broken docstrings on the dos module #2292.