Skip to content

📝 Refactor function signatures and improve docstring clarity#502

Merged
jacklovell merged 2 commits into
cherab:developmentfrom
munechika-koyo:fix/dosctrings-comments
Jul 14, 2026
Merged

📝 Refactor function signatures and improve docstring clarity#502
jacklovell merged 2 commits into
cherab:developmentfrom
munechika-koyo:fix/dosctrings-comments

Conversation

@munechika-koyo

Copy link
Copy Markdown
Member

Refactor function signatures to enhance consistency and clarity across multiple modules. Key changes include:

  • Updated function signatures from cpdef to cdef where appropriate.

  • Improved docstring phrasing for better readability.

  • Corrected parameter type references in docstrings.

  • Ensured consistency in error messages and return types.

Comment thread cherab/core/atomic/gaunt.pxd
Comment thread cherab/core/atomic/zeeman.pyx
@jacklovell

Copy link
Copy Markdown
Member

All looks fine to me. If you're happy to add a simple unit test for the error handling in zeeman.pyx then I think it'll be good to merge.

@jacklovell jacklovell merged commit ca96be3 into cherab:development Jul 14, 2026
11 of 12 checks passed
@munechika-koyo munechika-koyo deleted the fix/dosctrings-comments branch July 14, 2026 16:33
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