Added doc for Cursor object

[fortwoone]

The pygame.cursors.Cursor object is a brand new feature that I have just discovered, and I find sad that is is not documented already, so I tried to make a decent one

[Starbuck5]

It is documented, it's just that the docs on the website haven't been updated since 2.0.0. If you generate the docs locally you'll be able to see it, or if you snoop around the .rst files themselves.

It is a shame though, so I wrote a reddit post that will hopefully explain it to people before the docs get regenerated: https://www.reddit.com/r/pygame/comments/octscc/definitive_guide_to_pygame_cursors/.

With that in mind, do we need docstrings in the source? Maybe the docstrings would should up on some editors, which could help people out? But they should probably be a close copy of what is in the documentation itself.

[fortwoone]

Sure, but I noticed there was one init overload that was not documented, and I added it to the docstring inside the cursor object. It is not documented in the corresponding .rst file either sadly...

[Starbuck5]

The Cursor(cursor) overload is arguably not important to document, since it's assumed behavior from most python objects.

But if you want to document it you should change it in the documentation, not in a docstring.

Also, your docstring misses an __init__ case, for the old school 4 argument cursors.

[fortwoone]

Oh thanks for noticing. Do you think I should document it too ?

[fortwoone]

Ok so now I am finished

[Starbuck5]

Also, it would be good if you could build the docs locally, because that would forward your changes to src_c/doc/cursors_doc.h

It should just be python setup.py docs, but if you're on an outdated version of main, it requires installing the pygame build dependencies, which is difficult on Windows. I actually just got a docs README merged, so you can check the docs folder on Github to see that.

[fortwoone]

Ok I will check

[illume]

Nice improvements to the Cursor docs, thanks.

These two things remain:

• generate .h files (run python setup.py docs)
• fix thoses typo which should be those.

Let us know if you want us to finish these two things off? We can merge your branch in, and then fix them.

[fortwoone]

Which setup.py should I run ? The one from my fork or the original one ?

[fortwoone]

(also I corrected the typo)

[fortwoone]

I corrected the typo myself, can you generate the .h files please ?

[illume]

I corrected the typo myself, can you generate the .h files please ?

Cool, thanks. Will do.

[fortwoone]

I corrected the typo myself, can you generate the .h files please ?

Cool, thanks. Will do.

Thanks a lot