📚 workflows: Improve help strings for input parameters
#19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mbercx
requested changes
Dec 8, 2025
src/aiida_epw/workflows/prep.py
Outdated
| valid_type=(orm.RemoteData, orm.SinglefileData), | ||
| help=( | ||
| "A Julia script that converts the Wannier90 output files " | ||
| "(`prefix.chk`, `prefix.mmn`, ...) to the `epw.x` input format. This script is executed " |
Collaborator
There was a problem hiding this comment.
Can we add the file suffix here? It's .ukk, no? (based on the input name ^^)
Collaborator
Author
There was a problem hiding this comment.
Actually, for the latest version EPW>v6.0, not only .chk should be converted to .ukk, but also .mmn should be adapted a bit. So, I modified the .jl script for that. I tried to clarify this in the new commit. Maybe you can check if it's good.
src/aiida_epw/workflows/supercon.py
Outdated
| namespace_options={ | ||
| "help": "Inputs for the final isotropic `EpwBaseWorkChain`." | ||
| "help": ( | ||
| "Inputs for the final `EpwBaseWorkChain` that performs the `epw.x` calculation for the isotropic Migdal-Eliashberg equation. " |
Collaborator
There was a problem hiding this comment.
Hmm, strange that this passed the pre-commit. The line here is definitely too long. I think the default max line length should be 120 with Hatch.
clean up those `help` strings with unnecessarily technical information.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the help strings in
EpwBaseWorkChain,EpwPrepWorkChain,SuperConWorkChainto provide more detailed descriptions of the input parameters.