fix: comments

add comments on using strrep for name input of synchronous instruments
mathworks · Oct 6, 2023 · e995d79 · e995d79
1 parent 68a0985
commit e995d79
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/api/metrics/+opentelemetry/+metrics/Meter.m b/api/metrics/+opentelemetry/+metrics/Meter.m
@@ -38,6 +38,8 @@
             end
             import opentelemetry.common.mustBeScalarString
             ctname = mustBeScalarString(ctname);
+            % cpp-opentelemetry end does not allow string input with spaces,
+            % replace any spaces with underscores as a temporary fix
             ctname = strrep(ctname, ' ', '_');
             ctdescription = mustBeScalarString(ctdescription);
             ctunit = mustBeScalarString(ctunit);
@@ -58,6 +60,8 @@
 
             import opentelemetry.common.mustBeScalarString
             ctname = mustBeScalarString(ctname);
+            % cpp-opentelemetry end does not allow string input with spaces,
+            % replace any spaces with underscores as a temporary fix
             ctname = strrep(ctname, ' ', '_');
             ctdescription = mustBeScalarString(ctdescription);
             ctunit = mustBeScalarString(ctunit);
@@ -78,6 +82,8 @@
 
             import opentelemetry.common.mustBeScalarString
             hiname = mustBeScalarString(hiname);
+            % cpp-opentelemetry end does not allow string input with spaces,
+            % replace any spaces with underscores as a temporary fix
             hiname = strrep(hiname, ' ', '_');
             hidescription = mustBeScalarString(hidescription);
             hiunit = mustBeScalarString(hiunit);