Skip to content

Possible documentation improvements #2

Description

Hello, I've looked through your code and was thinking that the documentation could get more into detail. Especially in functions, describe the args and parameters and what they are used for so its easier and faster understandable what your function achieves. Also for really trivial functions I would remove unnecessary comments like for example get and set methods. I don't think there is a need to comment that it is a getter methods when it is obvious from the name. Thats all, overall it looks great though ;)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions