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 exported dual-series sparkline functions #303

New issue
Closed
opened 2026-07-07 09:42:24 +00:00 by the.auditor · 0 comments
the.auditor commented 2026-07-07 09:42:24 +00:00
Owner
Copy link

Three exported functions in internal/activity/renderer.go lack doc comments:

  • DualBrailleSparkline — should document dual-series encoding (left/right columns), 5-level normalization, and empty/mismatched handling
  • PRSparkline — wraps DualBrailleSparkline with PrsOpened/PrsClosed
  • IssueSparkline — wraps DualBrailleSparkline with IssuesOpened/IssuesClosed

Also: brailleDualChar level-4 branches are unreachable due to normalize() 0-7 range being halved to 0-3 via /2. Consider either using 5-level normalization or removing dead code.

Ref: PR #302

Three exported functions in `internal/activity/renderer.go` lack doc comments: - `DualBrailleSparkline` — should document dual-series encoding (left/right columns), 5-level normalization, and empty/mismatched handling - `PRSparkline` — wraps DualBrailleSparkline with PrsOpened/PrsClosed - `IssueSparkline` — wraps DualBrailleSparkline with IssuesOpened/IssuesClosed Also: `brailleDualChar` level-4 branches are unreachable due to normalize() 0-7 range being halved to 0-3 via `/2`. Consider either using 5-level normalization or removing dead code. Ref: PR #302
fuzzy added this to the Steeper project 2026-07-07 09:42:57 +00:00
fuzzy self-assigned this 2026-07-07 09:42:58 +00:00
fuzzy closed this issue 2026-07-08 08:05:40 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
fix/380-repoform-godoc-reset
v0.3.0
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
1 participant
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#303
No description provided.