From 43e7fcb2279a6d28886365bcd8277a63266346dc Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Wed, 15 Nov 2023 07:22:11 -0600 Subject: [PATCH] Fix the locale module docstring --- shared-bindings/locale/__init__.c | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/shared-bindings/locale/__init__.c b/shared-bindings/locale/__init__.c index 5ee71fc314..0ee0e8f8ab 100644 --- a/shared-bindings/locale/__init__.c +++ b/shared-bindings/locale/__init__.c @@ -27,9 +27,16 @@ #include "py/obj.h" #include "py/objtuple.h" -//| def getlocale(path: str, times: Tuple[int, int]) -> None: -//| """Change the timestamp of a file.""" -//| ... +//| """Locale support module""" +//| +//| def getlocale() -> None: +//| """Returns the current locale setting as a tuple ``(language code, "utf-8")`` +//| +//| The language code comes from the installed translation of CircuitPython, specifically the "Language:" code specified in the translation metadata. +//| This can be useful to allow modules coded in Python to show messages in the user's preferred language. +//| +//| Differences from CPython: No ``LC_*`` argument is permitted. +//| """ //| STATIC mp_obj_t getlocale(void) {