Skip to content

Misleading doc of locale argument defaults #542

Description

@xmo-odoo

Looking at the API doc for e.g. format_datetime, I just noticed that it states the default value for the locale parameter is 'en_US_POSIX'. That is very misleading as it actually uses the result of babel.core.default_locale('LC_TIME') which may not be anything like en_US_POSIX (and just happens to be so on the machine which built the documentation).

This can be fixed by providing an explicit signature as first line of the docstring (which will replace the extracted one) but I don't know that this is the fix the project would expect.

Please advise.

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions