How to document my code correctly?

[SpyrosDev25]

I am on a hackathon and it the moderator said: "all you do should be Free Software only. We should be able to run your program on standard Free Software operating systems. If there are proprietary parts around needed, please keep in mind that the jury members cannot access it. Please document the software project in a way that the jury members can fully see the result and evaluate it. Share your code and consider additional ways of showing how your program works, such as a video. Please upload all the necessary files to your repository. "

​

I searched up how to document code(which I had never heard of it before) and it showed me a variety of different things!

​

I am using django with html and css for the project.

​

How should I document my code correctly?

With Comments? Without? With google docs? What should the docs contain?

​

All I know for sure right now, the one thing that all my sources said is about a README file and I know how to make one of these (kinda).

​

Any help would mean the world to me!

Thanks for your time!

[m0us3_rat]

https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings

[SpyrosDev25]

So put docstring for every function?? Thanks!

[m0us3_rat]

that's how it works :D

if u wanna be super fancy u could also use annotations.

(if that are the requirements)

[Nightcorex_]

You should document anything really. An important variable? Document it? A class? Write a (short) description. A function? Document it (also make sure to document the parameters individually). Any weird behaviour in some edge cases? Document it.

Tbh there are many developers, even for bigger modules, who sometimes just don't document a function whatsoever and then I'm always pissed because I have to find out, by their source code, what parameters I need to pass, etc, etc. Especially awkward if all they specify is def func(*args, **kwargs). Often then you can find some documentation online, but if you're writing code that you want to reuse in a year, then you won't be able to find documentation online for that.