Skip to content

Doc improvement for formats._canonical_string_encoder / encode_canonical() #158

Open
@awwad

Description

@awwad

@lukpueh has correctly pointed out that formats._canonical_string_encoder()'s docstring is bad. It would be better not to have one, but better yet for it to be clear. It should be substantially more specific about the behavior the function intends and provides and why. It seems that this canonicalization policy is part of the motivation.

The docstring for formats.encode_canonical() should also be adjusted slightly to explain this policy.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions