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

[ENH] Descriptions as a command line tool? #54

Closed
cmaumet opened this issue Jul 20, 2023 · 2 comments · Fixed by #64
Closed

[ENH] Descriptions as a command line tool? #54

cmaumet opened this issue Jul 20, 2023 · 2 comments · Fixed by #64
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature ☝️ good first issue Good for newcomers 🏁 status: ready for dev Ready for work

Comments

@cmaumet
Copy link
Contributor

cmaumet commented Jul 20, 2023

Goal

It would be great to be able to interact with the descriptions written by the teams without having to write a custom script.

Why this is useful

Could look like maybe:

narps_description <TEAM_ID> <DESC_TYPE>

for example

narps_description 0ED6 preprocessing

Timeline

No response

More specifically

No response

Open questions

No response

@cmaumet cmaumet added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Jul 20, 2023
@bclenet
Copy link
Collaborator

bclenet commented Jul 20, 2023

Hi @cmaumet !

I think the description module addresses this ; you can have a look at its documentation here and tell me what you think.

Especially the second part of the documentation tells you how to use the command line, e.g.:

python narps_open/utils/description -t OED6 -d preprocessing

FYI, you don't need to run this script inside the docker container, it can run in a simple virtual environment.

@cmaumet
Copy link
Contributor Author

cmaumet commented Jul 20, 2023

Fantastic, thank you @bclenet! Maybe we could reverse the documentation with the command-line info first (for people like me who read things too quickly 😇...

(I did run the script locally without docker)

@bclenet bclenet added ☝️ good first issue Good for newcomers 🏁 status: ready for dev Ready for work ✨ goal: improvement Improvement to an existing feature 📄 aspect: text Concerns the textual material in the repository and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Jul 21, 2023
@bclenet bclenet linked a pull request Jul 21, 2023 that will close this issue
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature ☝️ good first issue Good for newcomers 🏁 status: ready for dev Ready for work
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants