KineticBloom / KineticBloom/Project_TRT

[EVERYONE TASK] Document ALL Old Code

Open
#270 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
5
Forks
0
PR merge metrics
No merged PRs in 30d

Description

In a branch branched off from `PROG_Documentation`, go over every script you have written for Project TRT and document them according to the documentation guidelines:
* Variable names descriptive enough to understand
* Public inspector editable variables have tooltips unless no information is communicated outside of it?
* Comments for all public functions
* If possible/have time, document private functions
Format code comments as thus (can use `///` to autogenerate this)
```
///
/// Summary here
///
/// Text for param.
/// Apple sauce
```
PR into `PROG_Documentation` NOT `main`.
There won't be a QA pass for this task. We trust you.

Contributor guide

No contributing guide indexed for this repository

Research direction

Work from a branch based on PROG_Documentation and review every script in Project TRT. Start with the listed variable naming, inspector tooltip, and XML comment requirements, using the shown /// format for public functions and private functions where possible. Done means all scripts have been reviewed and the PR targets PROG_Documentation rather than main; the issue states there is no QA pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.