Skip to content

Could do with more documentation for the Formatter class [procedures] in the values module #11

Description

@amn

Looks like the documentation strings for the methods of the Formatter class, have been written in somewhat inconsistent manner -- some of the procedures have doc. strings attached and some do not. There should be documentation for every part of the API, and per convention if the method is not private (i.e. with leading underscore in the name) and is part of a public construct, it should be documented and the documentation string is the canonical source of information for the method.

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions