Skip to content

Clean up io.vasp.outputs.Outcar docstring#4160

Merged
shyuep merged 44 commits intomaterialsproject:masterfrom
DanielYang59:outcar-parse-nbands
Jan 18, 2025
Merged

Clean up io.vasp.outputs.Outcar docstring#4160
shyuep merged 44 commits intomaterialsproject:masterfrom
DanielYang59:outcar-parse-nbands

Conversation

@DanielYang59
Copy link
Contributor

@DanielYang59 DanielYang59 commented Nov 9, 2024

Clean up io.vasp.outputs.Outcar docstring/comment

  • Greatly enhance type annotation for parsers in Outcar with more specific types, clarify docstring: Renders accessible from self.data (the internal self.data dictionary) vs Renders accessible from attributes (instance attributes)
  • Other docstring/comment cleanups

Others

  • Change getattr default value to False instead of None when used for condition check

@DanielYang59 DanielYang59 changed the title Clean up io.vasp.Outcar docstring Clean up io.vasp.outputs.Outcar docstring Nov 9, 2024
@DanielYang59 DanielYang59 force-pushed the outcar-parse-nbands branch 2 times, most recently from dfb33f7 to 404ed50 Compare November 9, 2024 10:27
@DanielYang59 DanielYang59 marked this pull request as ready for review November 23, 2024 13:36
@shyuep shyuep merged commit 876b999 into materialsproject:master Jan 18, 2025
42 checks passed
@DanielYang59 DanielYang59 deleted the outcar-parse-nbands branch January 19, 2025 02:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants