Fix the locale module docstring

This commit is contained in:
Jeff Epler 2023-11-15 07:22:11 -06:00
parent 918e244c13
commit 43e7fcb227
No known key found for this signature in database
GPG Key ID: D5BF15AB975AB4DE

View File

@ -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) {