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

More docs in template components #704

Closed
dkfellows opened this issue Nov 22, 2024 · 0 comments · Fixed by #705
Closed

More docs in template components #704

dkfellows opened this issue Nov 22, 2024 · 0 comments · Fixed by #705
Assignees

Comments

@dkfellows
Copy link
Collaborator

dkfellows commented Nov 22, 2024

Right now, we can attach human-readable documentation to parameters in our template components, but we can't do the same for command files, environments or task schemas. We ought to do that!

In particular, we currently render command files and environments in the documentation solely as:

damask_geom_file

FileSpec(label=’damask_geom_file’, name=FileNameSpec(geom.vti))

python_env

Environment(‘python_env’)

That provides absolutely no guidance at all to users what they might be or if they're relevant. I think this is more critical for the environments, as they also provide guidance to system administrators trying to set up matflow to work in a new cluster, and I've never met a sysadmin who wanted to read the documentation deeply. 😆

For task schemas, the human-readable documentation would be very useful too; it would help me describe to the user why they might use that particular template component, augmenting the current automatically-derived documentation of what the parameters to the component are.

In short, this is an area where we should do better than we do right now.


I believe that adding an additional (optional string) attribute, perhaps called doc, to the three relevant classes and updating the Jinja templates to make use of the attribute would be sufficient.

@dkfellows dkfellows linked a pull request Dec 3, 2024 that will close this issue
@dkfellows dkfellows moved this from 🔲 Todo to ▶ In Progress in hpcflow Master Project Dec 3, 2024
@github-project-automation github-project-automation bot moved this from ▶ In Progress to ✅ Done in hpcflow Master Project Dec 6, 2024
@dkfellows dkfellows self-assigned this Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant