jeroenheijmans / advent-of-code-charts

Inject charts in your private leaderboard page for Advent of Code
MIT License
120 stars 21 forks source link

Consider introducing JSDoc comments #82

Closed jeroenheijmans closed 10 months ago

jeroenheijmans commented 1 year ago

We don't use TypeScript, and the plugin is (semi-intentionally) AoC-style spaghetti code. This makes it hard for others to contribute. Specifically contributor @svatal pleaded in a comment to have JSDoc comments in the code. In fact, a good example of how it would work can be seen in their very first commit.

I'm opening a separate issue for this, because I don't think it should be tightly coupled to another unrelated feature request.

I'll add my own thoughts and concerns to a separate comment below, but first wanted to have an issue to refer to on this topic.