Cleanup: solo.read_TNR() (minor; docs.)

irfu · Mar 22, 2024 · ce04402 · ce04402
1 parent 1b8ec14
commit ce04402
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/mission/solar_orbiter/+solo/read_TNR.m b/mission/solar_orbiter/+solo/read_TNR.m
@@ -2,7 +2,7 @@
 %     Read L2 data from TNR.
 %
 %     @author: Louis Richard
-%     Updated by: Jordi Boldu
+%     Updated by: Jordi Boldu, Erik P G Johansson
 %
 %     NOTE: Uses irfu-matlab's solo.db_get_ts() and solo.db_list_files() for
 %     reading and locating CDF datasets.
@@ -25,7 +25,8 @@
 %     Returns
 %     -------
 %     out :
-%         Struct. Spectrum of the measured signals.
+%         Struct. Spectrum of the measured signals. Can be used as argument to
+%         irf_spectrogram().
 %         [], if there is are no TNR datasets for the specified period.
 %
 %     Notes
@@ -43,6 +44,7 @@
 data_l2 = read_raw_TNR_data(tint);
 
 if isempty(data_l2)
+  % There are no TNR datasets for the selected time interval.
   out = [];
   return
 end
@@ -141,6 +143,7 @@
   sens_ = sens1_;
   timet_ici = timet_(sens1_);
 else
+  % "there is no data on any sensor configuration"
   out = [];
   return;
   %irf.log('critical', 'no data at all ?!?')
@@ -239,7 +242,7 @@
 
 %%
 function Data = read_raw_TNR_data(tint)
-%     Read required raw TNR zVariables.
+%     Read selected TNR zVariables.
 %
 %     @author: Louis Richard. Modified by Erik P G Johansson.
 %