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.

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

Use the units outside of the comments for nicer docstrings #277

Merged
merged 1 commit into from
Feb 22, 2024

Conversation

tmadlener
Copy link
Contributor

BEGINRELEASENOTES

  • Use the units explictly in the yaml file to make them appear nicer in the generated docstrings.

ENDRELEASENOTES

@jmcarcell
Copy link
Contributor

Isn't it nice already?

2024-02-22-180943_364x46_scrot

Where do they appear when changed like in this PR?

@tmadlener
Copy link
Contributor Author

It's basically the same (modulo the in IIRC). But the generator has a unit in its hand which might become handy at some point. Additionally the yaml file get's slightly easier to read because the unit is further left, compared to at the end of a comment.

@jmcarcell jmcarcell merged commit 8c41350 into key4hep:main Feb 22, 2024
12 of 13 checks passed
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