Skip to content

Refactor everything to use consistent style for function docstrings #148

@calderast

Description

@calderast

Style points are real points!!

dear Josh and Loren who say I am a code perfectionist, one day I shall leave and be uncontactable but you will have all of this (beautifully!!!!!) documented code and yes it took me extra time now but it's going to save your future maze people YEARS over and over again. You're welcome.

Use convention "Parameters" (vs "args") and "Returns" (style match https://github.com/calderast/Hex-maze). Specify argument and return types in the function definitions.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationlow-priorityDo this eventually but not now (need more info, needed for a future experiment but not yet, etc)

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions