Closed tovrstra closed 4 months ago
This pull request addresses issue #362 by clarifying the use of physicists' versus chemists' notation conventions across multiple files. It corrects terminology in comments and docstrings, adds notes to clarify notation conventions, and improves docstring generation by conditionally including 'Notes' sections.
Files | Changes |
---|---|
iodata/formats/fcidump.py iodata/formats/gaussianlog.py iodata/iodata.py iodata/test/test_fcidump.py |
Corrected 'Physicist's notation' to 'physicists' notation' across multiple files to ensure consistency in terminology. |
iodata/formats/fcidump.py iodata/formats/gaussianlog.py |
Added LOAD_ONE_NOTES and DUMP_ONE_NOTES to clarify the use of physicists' and chemists' notation conventions. |
iodata/docstrings.py |
Improved docstring generation by conditionally adding 'Notes' section only when notes are present. |
Here's the code health analysis summary for commits dafc156..2d70fd1
. View details on DeepSource ↗.
Analyzer | Status | Summary | Link |
---|---|---|---|
Shell | ✅ Success | View Check ↗ | |
Python | ✅ Success | View Check ↗ |
💡 If you’re a repository administrator, you can configure the quality gates from the settings.
Thanks for checking!
This may help for issue #362. (If it doesn't, improving clarity never hurts.)
I've tried fixing related typos, and also fixed a minor in the docstring code: it now only adds a "Notes" section when there are notes.
Summary by Sourcery
This pull request standardizes the terminology from 'physicist's notation' to 'physicists' notation' across multiple files for consistency and improves the clarity of documentation by conditionally adding a 'Notes' section.