From 7d4c48023e689217621beb4e31c2158a19437b12 Mon Sep 17 00:00:00 2001
From: Olivier Sauter <olivier.sauter@epfl.ch>
Date: Tue, 15 Jan 2019 22:30:54 +0000
Subject: [PATCH] add comments for help
git-svn-id: https://spcsvn.epfl.ch/repos/TCV/gdat/trunk@11287 d63d8f72-b253-0410-a779-e742ad2e26cf
---
crpptbx/AUG/gdat_aug.m | 6 ++++++
crpptbx/gdat.m | 4 +++-
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/crpptbx/AUG/gdat_aug.m b/crpptbx/AUG/gdat_aug.m
index 6408b3ec..3f9caaf6 100644
--- a/crpptbx/AUG/gdat_aug.m
+++ b/crpptbx/AUG/gdat_aug.m
@@ -49,6 +49,12 @@ function [gdat_data,gdat_params,error_status,varargout] = gdat_aug(shot,data_req
% a5=gdat(32827,'ip'); % standard call
% a6=gdat(32827,'ip','Opt1',123,'Doplot',1,'opt2','Abc'); % standard call with a few options (note all lowercase in output)
% eqd = gdat(33134,'eqdsk','equil','IDE','time',2,'extra_arg_sf2sig','''-ed'',2');
+%
+% ip=gdat(shot,'ip'); % will show in ip.gdat_fullpath the effective signal used. In this case it is similar to ask:
+% ip=gdat(shot,{'FPC','IpiFP','AUGD'}); % or ip=gdat(shot,{'FPC','IpiFP'});
+%
+% so any signal can be loaded by giving the diagnostic, signal name and experiment, etc
+%
%
% Comments for local developer:
diff --git a/crpptbx/gdat.m b/crpptbx/gdat.m
index 2f331445..dc235198 100644
--- a/crpptbx/gdat.m
+++ b/crpptbx/gdat.m
@@ -49,7 +49,9 @@ function [gdat_data,gdat_params,error_status,varargout] = gdat(shot,data_request
% a4=gdat('opt1',123,'opt2',[1 2 3],'shot',48832,'data_request','Ip','opt3','aAdB'); % all in pairs
% a5=gdat(48836,'ip'); % standard call
% a6=gdat(48836,'ip','Opt1',123,'Doplot',1,'opt2','Abc'); % standard call with a few options (all lowercase in output)
-
+%
+% helps for specific machine: help gdat_tcv; help gdat_aug, help gdat_jet, etc
+%
%
% Comments for local developer:
--
GitLab