Documentation: Clarify usage
Closed this issue · 1 comments
cellistigs commented
Update https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fneurocaas.readthedocs.io%2Fen%2Flatest%2Fdevelop%2Fclidevguide.html%23main-script&data=05%7C01%7Cta2507%40cumc.columbia.edu%7Ca863ff418d1c4b8df02908db6664433d%7Cb0002a9b0017404d97dc3d3bab09be81%7C0%7C0%7C638216353053809011%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=JH%2BO02G%2FyU8Ll5%2F79hS5Yy4LGuQoI%2FuqDmkLOTx%2B4zc%3D&reserved=0 to specify how the path to the analysis script should be hardcoded.
cellistigs commented
We will change the docs in three ways.
- In
neurocaas/docs/source/develop/link.rst
, we will provide a more specific example of how theCOMMAND
field should look. - In
neurocaas/docs/source/develop/clidevguide.rst
, in the main script section, reference back to theCOMMAND
field. - In
neurocaas/docs/source/develop/clidevguide.rst
, rename the sectionsaving your machine image
as Saving your progress, and add in a section about updating the command section.