search

Dinnerbone / mcstatus

A Python class for checking the status of an enabled Minecraft server
http://dinnerbone.com/minecraft/tools/status/
1.11k stars 146 forks source link

Improve Documentation #109

Closed kevinkjt2000 closed 3 years ago

kevinkjt2000 commented 3 years ago

Docstrings should be included in various places, especially data-structures returned by top-level MinecraftServer functions. https://www.python.org/dev/peps/pep-0257/

Keep in mind, it would be nice to auto-generate versioned documention on gh-pages that the readme could link to.

Iapetus-11 commented 3 years ago

You mentioned you wanted to auto-generate docs from these docstrings, is there a specific type of docstring format you'd like to follow? Perhaps Sphinx?

kevinkjt2000 commented 3 years ago

Sphinx is okay with me :)

Iapetus-11 commented 3 years ago

Since part of Sphinx docstrings includes typehints, should I add typehints for args and methods outside of the docstrings as well?

kevinkjt2000 commented 3 years ago

Typehints would probably help out with #95 I'll take all the volunteering you're willing to offer 😃

HealingArcYT commented 3 years ago

Maybe also a more complete usage example? I had a kind of hard time finding MinecraftServer.status().version.name for example