From 89daf6d3f8aa72ee827efcf829e538a5272099b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Osterrath?= Date: Fri, 6 Aug 2021 16:29:51 -0400 Subject: [PATCH] Make todo mention a comment --- docs/VSCode.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/VSCode.rst b/docs/VSCode.rst index cb16d9f3..434520b9 100644 --- a/docs/VSCode.rst +++ b/docs/VSCode.rst @@ -2,8 +2,14 @@ Visual Studio Code ================== -One editor of choice for many researchers is VSCode. One feature of VSCode is remote editing through SSH. This allows you to edit files on the cluster as if they were local, open terminal sessions, and so on. +One editor of choice for many researchers is VSCode. One feature of VSCode is +remote editing through SSH. This allows you to edit files on the cluster as if +they were local, open terminal sessions, and so on. -Making it work on the Mila cluster is a bit tricky. Here are the current best instructions as to how to make it all work. +Making it work on the Mila cluster is a bit tricky. Here are the current best +instructions as to how to make it all work. -TODO: Adapt Mattie's work from https://github.com/mila-iqia/mila-docs/issues/16, but this is somewhat involved, so ideally I think we should write a script to automate it all (e.g. a user could write ``mila-vscode dirname`` and it would get the allocation, find the compute node name, and do the connection). +.. TODO: Adapt Mattie's work from https://github.com/mila-iqia/mila-docs/issues/16, + but this is somewhat involved, so ideally I think we should write a script to + automate it all (e.g. a user could write ``mila-vscode dirname`` and it would + get the allocation, find the compute node name, and do the connection).