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

[DOC] Lacking information about heudiconv commands populate-templates etc #696

Open
askieslinger opened this issue Aug 1, 2023 · 1 comment
Labels
documentation Changes only affect the documentation UX

Comments

@askieslinger
Copy link

Summary

Where can I find more information about the heudiconv commands mentioned here ?

--command Possible choices: heuristics, heuristic-info, ls, populate-templates, sanitize-jsons, treat-jsons, populate-intended-for Custom action to be performed on provided files instead of regular operation.

Specific information about each workflow would help a lot to be able to understand and use the tool.

@yarikoptic yarikoptic added UX documentation Changes only affect the documentation labels Aug 1, 2023
@yarikoptic
Copy link
Member

yeah, we should improve API (make them proper sub-commands) and documentation on this. ATM it is just looking at the code and searching through docs to find more description and examples of use as e.g. for populate-templates:
https://heudiconv.readthedocs.io/en/latest/search.html?q=populate-templates&check_keywords=yes&area=default would lead you to

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation UX
Projects
None yet
Development

No branches or pull requests

2 participants