Skip to content

Commit 43e7fcb

Browse files
committed
Fix the locale module docstring
1 parent 918e244 commit 43e7fcb

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

shared-bindings/locale/__init__.c

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,16 @@
2727
#include "py/obj.h"
2828
#include "py/objtuple.h"
2929

30-
//| def getlocale(path: str, times: Tuple[int, int]) -> None:
31-
//| """Change the timestamp of a file."""
32-
//| ...
30+
//| """Locale support module"""
31+
//|
32+
//| def getlocale() -> None:
33+
//| """Returns the current locale setting as a tuple ``(language code, "utf-8")``
34+
//|
35+
//| The language code comes from the installed translation of CircuitPython, specifically the "Language:" code specified in the translation metadata.
36+
//| This can be useful to allow modules coded in Python to show messages in the user's preferred language.
37+
//|
38+
//| Differences from CPython: No ``LC_*`` argument is permitted.
39+
//| """
3340
//|
3441
STATIC mp_obj_t getlocale(void) {
3542

0 commit comments

Comments
 (0)