Improved Documentation

Signed-off-by: Prathamesh Mutkure <pmutkure009@gmail.com>
jaegertracing · Sep 22, 2023 · 7c1d8f2 · 7c1d8f2
1 parent 70127d0
commit 7c1d8f2
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/packages/jaeger-ui/src/utils/date.tsx b/packages/jaeger-ui/src/utils/date.tsx
@@ -71,31 +71,31 @@ const quantizeDuration = (duration: number, floatPrecision: number, conversionFa
   toFloatPrecision(duration / conversionFactor, floatPrecision) * conversionFactor;
 
 /**
- * @param {number} duration (in microseconds)
+ * @param {number} duration - number of microseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC).
  * @return {string} formatted, unit-labelled string with time in milliseconds
  */
 export function formatDate(duration: number): string {
   return dayjs(duration / ONE_MILLISECOND).format(STANDARD_DATE_FORMAT);
 }
 
 /**
- * @param {number} duration (in microseconds)
+ * @param {number} duration - number of microseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC).
  * @return {string} formatted, unit-labelled string with time in milliseconds
  */
 export function formatTime(duration: number): string {
   return dayjs(duration / ONE_MILLISECOND).format(STANDARD_TIME_FORMAT);
 }
 
 /**
- * @param {number} duration (in microseconds)
+ * @param {number} duration - number of microseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC).
  * @return {string} formatted, unit-labelled string with time in milliseconds
  */
 export function formatDatetime(duration: number): string {
   return dayjs(duration / ONE_MILLISECOND).format(STANDARD_DATETIME_FORMAT);
 }
 
 /**
- * @param {number} duration (in microseconds)
+ * @param {number} duration - number of microseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC).
  * @return {string} formatted, unit-labelled string with time in milliseconds
  */
 export function formatMillisecondTime(duration: number): string {
@@ -104,7 +104,7 @@ export function formatMillisecondTime(duration: number): string {
 }
 
 /**
- * @param {number} duration (in microseconds)
+ * @param {number} duration - number of microseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC).
  * @return {string} formatted, unit-labelled string with time in seconds
  */
 export function formatSecondTime(duration: number): string {
@@ -120,7 +120,7 @@ export function formatSecondTime(duration: number): string {
  * 1000μs => 1ms
  * 183840s => 2d 3h
  *
- * @param {number} duration (in microseconds)
+ * @param {number} duration - number of microseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC).
  * @return {string} formatted duration
  */
 export function formatDuration(duration: number): string {