Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docstrings for ExcitationLine and RecombinationLine emission models. #435

Merged
merged 2 commits into from
May 16, 2024
Merged

Add docstrings for ExcitationLine and RecombinationLine emission models. #435

merged 2 commits into from
May 16, 2024

Conversation

vsnever
Copy link
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.

jacklovell
jacklovell requested changes May 14, 2024
View reviewed changes
Copy link
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.

cherab/core/model/plasma/impact_excitation.pyx Outdated Show resolved Hide resolved
cherab/core/model/plasma/recombination.pyx Outdated Show resolved Hide resolved
@vsnever
Copy link
Member Author

vsnever commented May 14, 2024

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

Mateasek
Mateasek approved these changes May 15, 2024
View reviewed changes
Copy link
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
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mateasek Mateasek Mateasek approved these changes

@jacklovell jacklovell jacklovell approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@vsnever @Mateasek @jacklovell