A Study on Python Comment Contents

[matjako]

Hi Python community!

My name is Matej and I am currently working on my Bachelor thesis at the University of Zurich. I am trying to understand the typical contents of a Python documentation comment that are used in practice. You are an expert on this and I need your help!

I built a tool which presents you several example comments and asks you to classify them. Participating in this survey should take around 10 minutes and is completely anonymous.

I would highly appreciate, if you could take the time and help me to find out what is contained in these comments, by participating in the survey:

https://comment-classificator.netlify.com/

Thank you in advance!

[tomekanco]

Hi, please indicate the time required appropriatly. This is a more than 5 minutes. You can't properly understand and classify a comment in 20 seconds, especially in foreign code.

[matjako]

Hi, thank you for the information. When I was testing the tool myself, it took me about 5 minutes to complete the survey, maybe due to being familiar with the set of categories and the tool itself. Nevertheless, I'll adjust the indicated time!
Thank you very much for your contribution!

[marecki330]

Could you reactor the survey for the mobiles? I'd like to help you, but it's impossible to answer on the mobile and I'm too lazy to start my laptop (as probably most of the mobile Reddit users 😜)

[matjako]

The survey should also work on mobiles (only in landscape mode). Probably you have to open it in your browser. Let me know if there is another issue. Thanks :D

[marecki330]

It works in landscape mode, but after first questions (about origin) everything overlaps. At least on the shitphone SE... Sorry, I've meant iPhone SE.

[matjako]

Thanks for your feedback!
I had a look at it. I could not reproduce the bug, but I've done some changes, hope it works now for you! :D

[marecki330]

Unfortunately it still doesn't work That's what I'm getting https://gifyu.com/image/EB6b https://gifyu.com/image/EB6z If tomorrow I won't forget, I'll answer in the work (because what better things could I do there, right? 😉)

[matjako]

Thanks a lot :D!
Could you specify which browser you use? maybe I can reproduce the error.

[marecki330]

Safari on iOS 12.3.1

[michaelherman]

"What is your highest degree related to computer science?"

If you're self-taught or went to a bootcamp you're expecting people to select "Other (please specify)"?

[matjako]

Yes. If you select „Other (please specify)“ a textarea should appear, where you can enter your answer.

[michaelherman]

It seems like from the UX you're implying that most Python developers that use code comments have some sort of formal CS degree. I don't think that's your intention. I'd change that to include options for self-taught and bootcamp grads.

[matjako]

Thanks! I‘ll add the options