240
submitted 1 day ago* (last edited 1 day ago) by raldone01@lemmy.world to c/programmerhumor@lemmy.ml

Python allows programmers to pass additional arguments to functions via comments. Now armed with this knowledge head out and spread it to all code bases.

Feel free to use the code I wrote in your projects.

Link to the source code: https://github.com/raldone01/python_lessons_py/blob/main/lesson_0_comments.ipynb

Image transcription:

from lib import add

# Go ahead and change the comments.
# See how python uses them as arguments.

result = add()  # 1 2
print(result)
result = add()  # 3 4
print(result)
result = add()  # 3 4 5 20
print(result)

Output:

3
7
32
you are viewing a single comment's thread
view the rest of the comments
[-] N0x0n@lemmy.ml 11 points 1 day ago* (last edited 1 day ago)

Thanks :) ! Could you tell me what use case/purpose such function can have from a dev perspective?

[-] bjorney@lemmy.ca 10 points 1 day ago

This stuff is normally used for creating human readable error messages. E.g. printing the line of your code that actually set off the exception

[-] vort3@lemmy.ml 8 points 1 day ago

I'd say nothing that can't be achieved by docstrings.

[-] justcallmelarry@lemmy.dbzer0.com 7 points 1 day ago* (last edited 1 day ago)

This specific use case? To make a meme, mainly ¯\(ツ)

As for the components: Parsing comments have been used for stuff like type hints / formatting / linting, tho generally not at run time (afaik).

The tooling for finding out where something is called from can be used to give a better understanding of where things go wrong when an exception happens or similar, to add to logs.

I would say that in general you don’t need either functionality except for certain edge-usecases

[-] N0x0n@lemmy.ml 3 points 1 day ago* (last edited 1 day ago)

Thank you ! 😄

[-] McWizard@lemmy.zip 1 points 1 day ago

We actually use method comments for user documentation as well. Only on specific business methods, but it's nice to have a good comment for the dev and a tooltip for the user at the same time.

this post was submitted on 21 Nov 2024
240 points (92.6% liked)

Programmer Humor

32558 readers
499 users here now

Post funny things about programming here! (Or just rant about your favourite programming language.)

Rules:

founded 5 years ago
MODERATORS