thwap/steeper
Watch
4
0
Fork
You've already forked steeper
 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

docs(activity): add godoc for HasHighActivity and HighActivityDays #333

Merged
fuzzy merged 1 commit from fix/318-high-activity-docs into main 2026-07-08 04:27:33 +00:00
Conversation 1 Commits 1 Files changed 1 +5
automation commented 2026-07-08 04:23:04 +00:00
Owner
Copy link

What

Add godoc comments to two exported methods on View:

  • HasHighActivity — reports whether any day exceeded the high-activity threshold
  • HighActivityDays — returns date strings of days with the high-activity flag

Why

These exported symbols lacked documentation. Godoc helps consumers understand when the status line renders warnings and how to retrieve the affected dates.

Testing

  • go vet ./... passes
  • go test -race -short ./... passes
  • golangci-lint passes
  • No functional changes — doc-only

Closes #318

## What Add godoc comments to two exported methods on `View`: - `HasHighActivity` — reports whether any day exceeded the high-activity threshold - `HighActivityDays` — returns date strings of days with the high-activity flag ## Why These exported symbols lacked documentation. Godoc helps consumers understand when the status line renders warnings and how to retrieve the affected dates. ## Testing - [x] `go vet ./...` passes - [x] `go test -race -short ./...` passes - [x] golangci-lint passes - [x] No functional changes — doc-only Closes #318
docs(activity): add godoc for HasHighActivity and HighActivityDays
All checks were successful
Test and Release / test (pull_request) Successful in 3m29s
Details
Test and Release / lint (pull_request) Successful in 4m26s
Details
0dbc36cd2a
fuzzy added this to the Steeper project 2026-07-08 04:25:04 +00:00
fuzzy self-assigned this 2026-07-08 04:25:05 +00:00
fuzzy scheduled this pull request to auto merge when all checks succeed 2026-07-08 04:25:08 +00:00
the.auditor approved these changes 2026-07-08 04:25:25 +00:00
the.auditor left a comment
Copy link

Review

Result: Approved — no issues. Closes #318.

5 lines of godoc added to HasHighActivity and HighActivityDays. No functional change. Builds and tests pass.

## Review **Result: Approved** — no issues. Closes #318. 5 lines of godoc added to `HasHighActivity` and `HighActivityDays`. No functional change. Builds and tests pass.
fuzzy merged commit 0dbc36cd2a into main 2026-07-08 04:27:33 +00:00
fuzzy deleted branch fix/318-high-activity-docs 2026-07-08 04:27:33 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
the.auditor
Labels
Clear labels   
Compat/Breaking
Breaking change that won't be backward compatible

  
Kind/Bug
Something is not working

  
Kind/Documentation
Documentation changes

  
Kind/Enhancement
Improve existing functionality

  
Kind/Feature
New functionality

  
Kind/Security
This is security issue

  
Kind/Testing
Issue or pull request related to testing

  
Priority
Critical
 The priority is critical

  
Priority
High
 The priority is high

  
Priority
Low
 The priority is low

  
Priority
Medium
 The priority is medium

  
Reviewed
Confirmed
 Issue has been confirmed

  
Reviewed
Duplicate
 This issue or pull request already exists

  
Reviewed
Invalid
 Invalid issue

  
Reviewed
Won't Fix
 This issue won't be fixed

  
Status
Abandoned
 Somebody has started to work on this but abandoned work

  
Status
Blocked
 Something is blocking this issue or pull request

  
Status
Need More Info
 Feedback is required to reproduce issue or to continue work

No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Steeper
Assignees
Clear assignees
No assignees
fuzzy
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
thwap/steeper!333
No description provided.