Update docstrings for ThermalElectronic #203
Conversation
Updated class docstring for ThermalElectronic to improve clarity and structure.
Updated formulas for clarity and fixed LaTeX syntax in comments and docstrings.
Updated the formula for thermal electronic entropy calculation to include the Fermi-Dirac distribution.
Removed mathematical formulas from docstrings for various functions related to thermal electronic calculations.
Removed redundant bullet points from usage instructions.
There was a problem hiding this comment.
Pull request overview
This pull request updates the docstrings for the ThermalElectronic class and related documentation configuration to improve clarity and consistency. The changes enhance the documentation by providing more detailed parameter descriptions, better formatting, and improved type hints.
Changes:
- Enhanced docstrings throughout the
ThermalElectronicclass with more detailed parameter descriptions, units, and formatting - Updated Sphinx Napoleon configuration to properly handle Google and NumPy style docstrings
- Restructured documentation RST file to explicitly document
ThermalElectronicandThermalElectronicDataclasses
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| dfttk/thermal_electronic/thermal_electronic.py | Updated class and method docstrings with improved formatting, added units, better parameter descriptions, and return type annotations |
| docs/conf.py | Added Napoleon extension configuration options and set autodoc member order to 'bysource'; removed unused extensions |
| docs/api/dfttk.thermal_electronic.rst | Changed from module-level to class-level documentation directives for better organization |
| tests/test_thermal_electronic.py | Reformatted multi-line error message string for better readability |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.