Skip to content

Add docstrings for ExcitationLine and RecombinationLine emission models.#435

Merged
jacklovell merged 2 commits into
cherab:developmentfrom
vsnever:docs/line_emission_models
May 16, 2024
Merged

Add docstrings for ExcitationLine and RecombinationLine emission models.#435
jacklovell merged 2 commits into
cherab:developmentfrom
vsnever:docs/line_emission_models

Conversation

@vsnever
Copy link
Copy Markdown
Member

@vsnever vsnever commented May 13, 2024

This adds missing docstrings for ExcitationLine and RecombinationLine emission models. This was originally part of #386, but has been moved to a separate PR.

Copy link
Copy Markdown
Member

@jacklovell jacklovell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. I suggest using raw strings to reduce the number of backslashes required, but otherwise looks good.

Comment thread cherab/core/model/plasma/impact_excitation.pyx Outdated
Comment thread cherab/core/model/plasma/recombination.pyx Outdated
@vsnever
Copy link
Copy Markdown
Member Author

vsnever commented May 14, 2024

Thanks, @jacklovell, I converted docstrings to raw string format.

Copy link
Copy Markdown
Member

@Mateasek Mateasek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @vsnever , looks good to me, thanks for writing it.

@jacklovell jacklovell merged commit 5a66349 into cherab:development May 16, 2024
@vsnever vsnever deleted the docs/line_emission_models branch August 30, 2024 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants