Skip to content
Snippets Groups Projects
Commit cf9cfe45 authored by Antonia Frank's avatar Antonia Frank
Browse files

Correct and clean-up comment sections

parent be95e0f5
No related branches found
No related tags found
1 merge request!137Add quantities to ids for MRE
function [ids_core_transport,ids_core_transport_description,varargout] = ... function [ids_core_transport,ids_core_transport_description,varargout] = ...
tcv_get_ids_core_transport(shot,ids_equil_empty,gdat_params,varargin) tcv_get_ids_core_transport(shot,ids_equil_empty,gdat_params,varargin)
% %
% [ids_core_profiles,ids_core_profiles_description,varargout] = ... % [ids_core_transport,ids_core_transport_description,varargout] = ...
% tcv_get_ids_core_profiles(shot,ids_equil_empty,gdat_params,varargin); % 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 % gdat_params: gdat_data.gdat_params to get all params passed from original call
......
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); % [ids_generic, params_ids_generic] = tcv_ids_headpart(shot,ids_in,ids_name,varargin);
% %
% parses inputs and fill in ids_properties % parses inputs and fill in ids_properties
% %
%
% varargin options: % varargin options:
% % 'comment': comment to include in ids_properties, using gdat_params
% 'comment': comment to include in ids_properties, using gdat_params for example cocos_in and cocos_out % 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 % 'homogeneous_time': homogeneous_time in ids_properties:
% 'gdat_params': gdat params structure % 1 (default) if the whole ids has same time, 0 otherwise
% 'gdat_params': gdat params structure
% %
% %
% example: % example:
% [ids_equilibrium, params_ids_equilibrium] = tcv_ids_headpart(shot,ids_equil_empty,'equilibrium','comment','your comment'); % [ids_equilibrium, params_ids_equilibrium] = tcv_ids_headpart(shot,ids_equil_empty,'equilibrium','comment','your comment');
% %
%
% initialize input parser % initialize input parser
p = inputParser; p = inputParser;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment