Skip to content

Instantly share code, notes, and snippets.

@c10r
Created April 17, 2025 16:47
Show Gist options
  • Save c10r/d4da03b4baf43d4ad6f62c018d25972f to your computer and use it in GitHub Desktop.
Save c10r/d4da03b4baf43d4ad6f62c018d25972f to your computer and use it in GitHub Desktop.
Documentation styles
/** 1️⃣ **/
// The id is the workspace id
async getWorkspace(id: string) {
}
/** 2️⃣ **/
async getWorkspace(workspaceId: string) {
}
/** 1️⃣ **/
async getCalendar(calendarId: string) {
// apple hard codes 429 to be the private calendar
if (calendarId == 429) {
return null
}
}
/** 2️⃣ **/
async getCalendar(calendarId: string) {
if (calendarId == PRIVATE_APPLE_CALENDAR_ID) {
return null
}
}
/** 1️⃣ **/
async calculateNumSchedules(userId: string) {
let accum = 0 // Set the accumulator to 0
...
return accum
}
/** 2️⃣ **/
async calculateNumSchedules(userId: string) {
let accum = 0
...
return accum
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment