summaryrefslogtreecommitdiff
path: root/shared-bindings/struct
diff options
context:
space:
mode:
authordherrada <dylan.herrada@gmail.com>2020-05-12 11:28:33 -0400
committerdherrada <dylan.herrada@gmail.com>2020-05-12 11:28:33 -0400
commit991045b9ce958db9d7102d621f4e7860301e4c21 (patch)
tree2dfbc434cc3c2268ef01c6f7a6389c306f56a973 /shared-bindings/struct
parent603df58f971743bc36b9e391cd5fb04812262533 (diff)
Did struct, supervisor, terminalio
Diffstat (limited to 'shared-bindings/struct')
-rw-r--r--shared-bindings/struct/__init__.c48
1 files changed, 24 insertions, 24 deletions
diff --git a/shared-bindings/struct/__init__.c b/shared-bindings/struct/__init__.c
index ea14b3763..3772f93a7 100644
--- a/shared-bindings/struct/__init__.c
+++ b/shared-bindings/struct/__init__.c
@@ -38,7 +38,7 @@
#include "shared-module/struct/__init__.h"
#include "supervisor/shared/translate.h"
-//| :mod:`struct` --- manipulation of c-style data
+//| """:mod:`struct` --- manipulation of c-style data
//| ========================================================
//|
//| .. module:: struct
@@ -52,13 +52,13 @@
//| Supported size/byte order prefixes: *@*, *<*, *>*, *!*.
//|
//| Supported format codes: *b*, *B*, *x*, *h*, *H*, *i*, *I*, *l*, *L*, *q*, *Q*,
-//| *s*, *P*, *f*, *d* (the latter 2 depending on the floating-point support).
+//| *s*, *P*, *f*, *d* (the latter 2 depending on the floating-point support)."""
//|
-//| .. function:: calcsize(fmt)
-//|
-//| Return the number of bytes needed to store the given fmt.
+//| def calcsize(fmt: Any) -> Any:
+//| """Return the number of bytes needed to store the given fmt."""
+//| ...
//|
STATIC mp_obj_t struct_calcsize(mp_obj_t fmt_in) {
@@ -67,10 +67,10 @@ STATIC mp_obj_t struct_calcsize(mp_obj_t fmt_in) {
}
MP_DEFINE_CONST_FUN_OBJ_1(struct_calcsize_obj, struct_calcsize);
-//| .. function:: pack(fmt, *values)
-//|
-//| Pack the values according to the format string fmt.
-//| The return value is a bytes object encoding the values.
+//| def pack(fmt: Any, *values: Any) -> Any:
+//| """Pack the values according to the format string fmt.
+//| The return value is a bytes object encoding the values."""
+//| ...
//|
STATIC mp_obj_t struct_pack(size_t n_args, const mp_obj_t *args) {
@@ -85,10 +85,10 @@ STATIC mp_obj_t struct_pack(size_t n_args, const mp_obj_t *args) {
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(struct_pack_obj, 1, MP_OBJ_FUN_ARGS_MAX, struct_pack);
-//| .. function:: pack_into(fmt, buffer, offset, *values)
-//|
-//| Pack the values according to the format string fmt into a buffer
-//| starting at offset. offset may be negative to count from the end of buffer.
+//| def pack_into(fmt: Any, buffer: Any, offset: Any, *values: Any) -> Any:
+//| """Pack the values according to the format string fmt into a buffer
+//| starting at offset. offset may be negative to count from the end of buffer."""
+//| ...
//|
STATIC mp_obj_t struct_pack_into(size_t n_args, const mp_obj_t *args) {
@@ -111,11 +111,11 @@ STATIC mp_obj_t struct_pack_into(size_t n_args, const mp_obj_t *args) {
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(struct_pack_into_obj, 3, MP_OBJ_FUN_ARGS_MAX, struct_pack_into);
-//| .. function:: unpack(fmt, data)
-//|
-//| Unpack from the data according to the format string fmt. The return value
-//| is a tuple of the unpacked values. The buffer size must match the size
-//| required by the format.
+//| def unpack(fmt: Any, data: Any) -> Any:
+//| """Unpack from the data according to the format string fmt. The return value
+//| is a tuple of the unpacked values. The buffer size must match the size
+//| required by the format."""
+//| ...
//|
STATIC mp_obj_t struct_unpack(size_t n_args, const mp_obj_t *args) {
@@ -129,12 +129,12 @@ STATIC mp_obj_t struct_unpack(size_t n_args, const mp_obj_t *args) {
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(struct_unpack_obj, 2, 3, struct_unpack);
-//| .. function:: unpack_from(fmt, data, offset=0)
-//|
-//| Unpack from the data starting at offset according to the format string fmt.
-//| offset may be negative to count from the end of buffer. The return value is
-//| a tuple of the unpacked values. The buffer size must be at least as big
-//| as the size required by the form.
+//| def unpack_from(fmt: Any, data: Any, offset: Any = 0) -> Any:
+//| """Unpack from the data starting at offset according to the format string fmt.
+//| offset may be negative to count from the end of buffer. The return value is
+//| a tuple of the unpacked values. The buffer size must be at least as big
+//| as the size required by the form."""
+//| ...
//|
STATIC mp_obj_t struct_unpack_from(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {