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

Add tasks docs_info #876

Merged
merged 22 commits into from
Dec 16, 2024
Merged

Add tasks docs_info #876

merged 22 commits into from
Dec 16, 2024

Conversation

jluethi
Copy link
Collaborator

@jluethi jluethi commented Dec 13, 2024

Draft of polished tasks_info for each of the core tasks.

@tcompa This is to address #874 (comment)

While setting it up, I started liking the pattern of mostly defining Purpose & Limitations, but some tasks get extra info. This shows for me that it's indeed valuable to use markdown files, not just strings (as you suggested in the issue).

Can we adapt the manifest building to load the file content if a task contains something like docs_info="file:task_info/convert_cellvoyager_to_ome_zarr.md"?

Checklist before merging

  • I added an appropriate entry to CHANGELOG.md

Copy link

Coverage report

This PR does not seem to contain any modification to coverable code.

@tcompa tcompa marked this pull request as ready for review December 16, 2024 08:38
@tcompa
Copy link
Collaborator

tcompa commented Dec 16, 2024

This is ready, from my side.

A couple of minor remarks:

  1. I had to open&fix Deprecate check_manifest.py (in favor of recreate+diff) #877
  2. I introduced support for docs_info being set to file:XYZ, where XYZ is a relative path. The absolute path of the docs file is then built by combining the base folder where task_list.py lives with this XYZ relative path.

@jluethi
Copy link
Collaborator Author

jluethi commented Dec 16, 2024

@tcompa That sounds good to me :)
I added a little bit of extra formatting (making some text elements bold). With that, I'd say we can merge & release that. I'll then add that to the template later & start making another round of PRs to repos after that.

@tcompa tcompa merged commit ce80baf into main Dec 16, 2024
@tcompa tcompa deleted the 874_updated_tasks_info branch December 16, 2024 15:12
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