p2r3 / epochtal

Portal 2 tournament framework
https://epochtal.p2r3.com/
GNU General Public License v3.0
8 stars 4 forks source link

Write documentation for the entire project #1

Closed PancakeTAS closed 2 months ago

PancakeTAS commented 3 months ago

List of files without proper documentation (as of commit 4f296c2):

PancakeTAS commented 3 months ago

I went through all files again, tried to fix some inconsistencies and also removed quite a bit of documentation that was either completely obvious or redundant for a specific block. I added a CONTRIBUTING.md file to make sure that in the future we can sort of keep it consistent, though I need some feedback from @p2r3 and @soni801 on whether the guidelines I went with are appropriate.

(on an unrelated note... half way woo!!!)

soni801 commented 2 months ago

I'm just doing the easiest ones first lol, will continue to mention the issue in my commits so it's easier for you to update the task list

PancakeTAS commented 2 months ago

mark them off yourself you lazy-

soni801 commented 2 months ago

I did not know i could do that on someone elses issue lol

PancakeTAS commented 2 months ago

@soni801 please never ever link them in your commit message again, lmfao

soni801 commented 2 months ago

lmaoooooo thats too funny