#🔒 Any feedback on documentation?

6 messages · Page 1 of 1 (latest)

rough blade
#

I started a course called 100 Days of Code: The Complete Python Pro Bootcamp. Which is basically one project per day. So I thought, hey, why not post these projects on GitHub? However, I'm nothing but a beginner programmer and this is my first time doing this.

I'm not sure about my documentation nor my comments. If anyone can provide any feedback on them, I would greatly appreciate it. And if you can provide some examples of good documentation for projects like these, that would be even better.

This is a list of the projects I made so far:
https://github.com/Bosaif39/A-List-of-100-Days-of-Code-The-Complete-Python-Pro-Bootcamp-Projects

GitHub
GitHub - Bosaif39/A-List-of-100-Days-of-Code-The-Complete-Python-Pr...

A list linked to all projects I made doing this course - Bosaif39/A-List-of-100-Days-of-Code-The-Complete-Python-Pro-Bootcamp-Projects

narrow mirageBOT
#

@rough blade

Python help channel opened

Remember to:

  • Ask your Python question, not if you can ask or if there's an expert who can help.
  • Show a code sample as text (rather than a screenshot) and the error message, if you've got one.
  • Explain what you expect to happen and what actually happens.

:warning: Do not pip install anything that isn't related to your question, especially if asked to over DMs.

Closes after a period of inactivity, or when you send !close.
short wasp
# rough blade I started a course called 100 Days of Code: The Complete Python Pro Bootcamp. Wh...

Here's my two cents:
Try to document functionality and intent instead of simply stating what the code is. Some things are self-explanatory to anybody reading the code. There are several comments such as "A list of letters" or "While loop to use the function" (from project 8) that do not provide anything of substance. A fellow programmer can see the while keyword and know that it is a while loop. Instead it could be better to answer less obvious questions others may have:

  • Why are you using a while loop here?
  • What is this variable used for?
  • Why did you implement X using Y instead of Z?

Good luck on your "100 days of code" :-)

rough blade
narrow mirageBOT
#
Python help channel closed

This help channel has been closed and it's no longer possible to send messages here. If your question wasn't answered, feel free to create a new post in #1035199133436354600. To maximize your chances of getting a response, check out this guide on asking good questions.