Adjusting doc string

130192d5 · Josh Slaughter · 5ea6bc69 · 130192d5
Commit 130192d5 authored 2 years ago by Josh Slaughter
Hide whitespace changes
Inline Side-by-side

Showing

with 2 additions and 0 deletions
+2 -0
--- a/frontend/packages/core/src/timeago.tsx
+++ b/frontend/packages/core/src/timeago.tsx
@@ -30,6 +30,8 @@ const setMilliseconds = (timestamp?: number | Long | null): number => {
 /**
 * Will take a millsecond timestamp in and calculate the timeago for it
 * @param date the millisecond timestamp
+ * @param short (default) will shorten the unit string (day -> d)
+ * @param live (default) will auto increment based on a given time
 * @returns react component representing the timeago
 */
 const TimeAgo = ({ short = true, onClick, ...props }: EventTimeProps) => (