From cf9cfe45db0c9445a6f75c46e9f4d0c4891b158e Mon Sep 17 00:00:00 2001 From: Antonia Frank <antonia.frank@epfl.ch> Date: Mon, 19 Feb 2024 19:55:26 +0100 Subject: [PATCH] Correct and clean-up comment sections --- matlab/TCV_IMAS/tcv_get_ids_core_transport.m | 4 ++-- matlab/TCV_IMAS/tcv_ids_headpart.m | 13 ++++++------- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/matlab/TCV_IMAS/tcv_get_ids_core_transport.m b/matlab/TCV_IMAS/tcv_get_ids_core_transport.m index 48edb64f..7715f615 100644 --- a/matlab/TCV_IMAS/tcv_get_ids_core_transport.m +++ b/matlab/TCV_IMAS/tcv_get_ids_core_transport.m @@ -1,8 +1,8 @@ function [ids_core_transport,ids_core_transport_description,varargout] = ... tcv_get_ids_core_transport(shot,ids_equil_empty,gdat_params,varargin) % -% [ids_core_profiles,ids_core_profiles_description,varargout] = ... -% tcv_get_ids_core_profiles(shot,ids_equil_empty,gdat_params,varargin); +% [ids_core_transport,ids_core_transport_description,varargout] = ... +% tcv_get_ids_core_transport(shot,ids_equil_empty,gdat_params,varargin); % % % gdat_params: gdat_data.gdat_params to get all params passed from original call diff --git a/matlab/TCV_IMAS/tcv_ids_headpart.m b/matlab/TCV_IMAS/tcv_ids_headpart.m index fa90b8cf..53216596 100644 --- a/matlab/TCV_IMAS/tcv_ids_headpart.m +++ b/matlab/TCV_IMAS/tcv_ids_headpart.m @@ -1,21 +1,20 @@ -function [ids_generic, params_ids_generic] = tcv_ids_headpart(shot,ids_in,ids_name,varargin); +function [ids_generic, params_ids_generic] = tcv_ids_headpart(shot,ids_in,ids_name,varargin) % % [ids_generic, params_ids_generic] = tcv_ids_headpart(shot,ids_in,ids_name,varargin); % % parses inputs and fill in ids_properties % -% % varargin options: -% -% 'comment': comment to include in ids_properties, using gdat_params for example cocos_in and cocos_out -% 'homogeneous_time': homogeneous_time in ids_properties: 1 (default) if the whole ids has same time, 0 otherwise -% 'gdat_params': gdat params structure +% 'comment': comment to include in ids_properties, using gdat_params +% for example cocos_in and cocos_out +% 'homogeneous_time': homogeneous_time in ids_properties: +% 1 (default) if the whole ids has same time, 0 otherwise +% 'gdat_params': gdat params structure % % % example: % [ids_equilibrium, params_ids_equilibrium] = tcv_ids_headpart(shot,ids_equil_empty,'equilibrium','comment','your comment'); % -% % initialize input parser p = inputParser; -- GitLab