Home

Welcome to the proj-minecraft wiki!

Here, we document coding conventions used. In the near future, we may use this wiki to contain 1) setup details that do not fit in the README, and 2) documentation for our code.

Docstrings Convention: We shall Adopt PEP287 recommendation to use the reStructuredText (reST) format for docstrings (in-code documentation found at the start of each method or class). This is a widely-adopted format that is used by Sphinx to auto-generate documentation. An example is shown below.

def break_leg(param1, param2):
    """
    This method breaks a leg.

    :param param1: this is a first param
    :param param2: this is a second param
    :returns: this is a description of what is returned
    :raises keyError: raises an exception
    """

Also here is a fantastic cheatsheet for writing markdown.