korlibs / korlibs/docs.korge.org

Add class comment for Signal/BaseSignal

Open
#14 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
CSS
Stars
3
Forks
3
PR merge metrics
No merged PRs in 30d

Description

**Describe the bug**

I'm confused about how the signal stuff works, would be great if the class itself had header comments.

**Annoyment level**

> How annoyed are you in a scale of 1-3 because this shitty code doesn't work properly

* [x] 1 - No rush from my side
* [ ] 2 - It is inconvenient, but I can circumvent the issue for now
* [ ] 3 - FUUUU
* [ ] 4

**Payment**

sponsor.

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the Signal and BaseSignal classes and read their surrounding code to understand what the class comments should explain. Add header comments to both classes describing how the signal code works, then verify that the comments are present and accurate.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.