fix: add missing classes in docs and fix formatting errors (FXC-4270)

[damiano-flex]

Greptile Overview

Updated On: 2025-09-24 09:13:09 UTC

Summary

This PR addresses documentation completeness and formatting issues by adding missing class references and fixing various formatting errors.

Key changes include:

• Added missing "Effective Density Of States (DOS)" and "Energy Bandgap" sections in charge mediums documentation with proper class references
• Added missing SteadyChargeDCAnalysis class reference to the SPICE analysis documentation
• Fixed docstring formatting by properly formatting boolean values with backticks
• Improved LaTeX mathematical formula formatting by correcting math blocks and notation
• Fixed file endings and general formatting consistency

Confidence Score: 5/5

• This PR is safe to merge with no risk
• This PR contains only documentation improvements with no code logic changes, making it completely safe to merge
• No files require special attention

Important Files Changed

File Analysis

Filename	Score	Overview
docs/api/charge/mediums.rst	5/5	Added missing Effective Density Of States (DOS) and Energy Bandgap sections with proper class references, and fixed missing newline at end of file
docs/api/spice.rst	5/5	Added missing SteadyChargeDCAnalysis class reference to the Analysis section
tidy3d/components/spice/analysis/dc.py	5/5	Fixed formatting in docstring by properly formatting 'False' with backticks for consistent documentation rendering
tidy3d/components/tcad/bandgap_energy.py	5/5	Fixed mathematical formula formatting by removing improper equation environment and correcting LaTeX markup
tidy3d/components/tcad/effective_DOS.py	5/5	Updated units constant usage and fixed mathematical formula formatting by restructuring math blocks and improving LaTeX notation

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant RST as RST Docs
    participant PY as Python Files
    participant Sphinx as Documentation Builder
    
    Dev->>RST: Add missing class references
    Dev->>RST: Fix formatting errors
    Dev->>PY: Fix docstring formatting
    Dev->>PY: Improve LaTeX math notation
    RST->>Sphinx: Generate API documentation
    PY->>Sphinx: Extract docstrings for rendering
    Sphinx->>Dev: Complete documentation build

Loading

[greptile-apps]

_{5 files reviewed, no comments}

_{Edit Code Review Bot Settings | Greptile}

[github-actions]

Diff Coverage

Diff: origin/develop...HEAD, staged and unstaged changes

• tidy3d/components/tcad/effective_DOS.py (100%)

Summary

• Total: 1 line
• Missing: 0 lines
• Coverage: 100%

[marc-flex]

Thanks @damiano-flex!!

Unless someone else has any objection feel free to squash commits and merge

[daquinteroflex]

can we merge this?