Skip to content

Commit 82f56fd

Browse files
committed
docs(log): improve JSDoc on view command functions
1 parent 6d9efec commit 82f56fd

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

src/commands/log/view.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ const USAGE_HINT = "sentry log view <org>/<project> <log-id>";
2727
* Parse positional arguments for log view.
2828
* Handles: `<log-id>` or `<target> <log-id>`
2929
*
30+
* @param args - Positional arguments from CLI
3031
* @returns Parsed log ID and optional target arg
32+
* @throws {ContextError} If no arguments provided
3133
*/
3234
export function parsePositionalArgs(args: string[]): {
3335
logId: string;
@@ -49,7 +51,6 @@ export function parsePositionalArgs(args: string[]): {
4951

5052
const second = args[1];
5153
if (second === undefined) {
52-
// Should not happen given length check, but TypeScript needs this
5354
return { logId: first, targetArg: undefined };
5455
}
5556

@@ -106,6 +107,11 @@ async function resolveFromProjectSearch(
106107

107108
/**
108109
* Write human-readable log output to stdout.
110+
*
111+
* @param stdout - Output stream
112+
* @param log - The log entry to display
113+
* @param orgSlug - Organization slug for trace URLs
114+
* @param detectedFrom - Optional context detection source to display
109115
*/
110116
function writeHumanOutput(
111117
stdout: Writer,

0 commit comments

Comments
 (0)