From 64ea5e341c1095c04a28454f819122e79615a4de Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Fri, 16 Jul 2021 15:42:00 +0200 Subject: [PATCH] ubuiltins: Sort classes and functions by use case. --- doc/main/micropython/builtins.rst | 186 +++++++++++++++++------------- 1 file changed, 103 insertions(+), 83 deletions(-) diff --git a/doc/main/micropython/builtins.rst b/doc/main/micropython/builtins.rst index 1a35465..56a80c5 100644 --- a/doc/main/micropython/builtins.rst +++ b/doc/main/micropython/builtins.rst @@ -1,115 +1,135 @@ Built-in classes and functions ===================================================== -.. automodule:: ubuiltins - :no-members: -.. autofunction:: ubuiltins.abs - -.. autofunction:: ubuiltins.all - -.. autofunction:: ubuiltins.any - -.. autofunction:: ubuiltins.bin +Classes and types +---------------------- .. autoclass:: ubuiltins.bool .. autoclass:: ubuiltins.bytes -.. autofunction:: ubuiltins.callable - -.. autofunction:: ubuiltins.chr - -.. autofunction:: ubuiltins.classmethod - .. autoclass:: ubuiltins.complex .. autoclass:: ubuiltins.dict -.. autofunction:: ubuiltins.dir - -.. autofunction:: ubuiltins.divmod - -.. autoclass:: ubuiltins.enumerate - -.. autofunction:: ubuiltins.eval - -.. autofunction:: ubuiltins.exec - .. autoclass:: ubuiltins.float -.. autofunction:: ubuiltins.getattr - -.. autofunction:: ubuiltins.globals - -.. autofunction:: ubuiltins.hasattr - -.. autofunction:: ubuiltins.hash - -.. autofunction:: ubuiltins.help - -.. autofunction:: ubuiltins.hex - -.. autofunction:: ubuiltins.id - -.. autofunction:: ubuiltins.input - .. autoclass:: ubuiltins.int -.. autofunction:: ubuiltins.isinstance - -.. autofunction:: ubuiltins.issubclass - -.. autofunction:: ubuiltins.iter - -.. autofunction:: ubuiltins.len - .. autoclass:: ubuiltins.list -.. autofunction:: ubuiltins.locals - -.. autofunction:: ubuiltins.map - -.. autofunction:: ubuiltins.max - -.. autofunction:: ubuiltins.min - -.. autofunction:: ubuiltins.next - .. autoclass:: ubuiltins.object -.. autofunction:: ubuiltins.oct - -.. autofunction:: ubuiltins.ord - -.. autofunction:: ubuiltins.pow - -.. autofunction:: ubuiltins.print - .. autoclass:: ubuiltins.range -.. autofunction:: ubuiltins.repr - -.. autofunction:: ubuiltins.reversed - -.. autofunction:: ubuiltins.round - -.. autofunction:: ubuiltins.setattr - .. autoclass:: ubuiltins.slice -.. autofunction:: ubuiltins.sorted - -.. autofunction:: ubuiltins.staticmethod - .. autoclass:: ubuiltins.str -.. autofunction:: ubuiltins.sum - -.. autofunction:: ubuiltins.super - .. autoclass:: ubuiltins.tuple .. autoclass:: ubuiltins.type +Math-related functions +---------------------- + +.. autofunction:: ubuiltins.abs + +.. autofunction:: ubuiltins.divmod + +.. autofunction:: ubuiltins.max + +.. autofunction:: ubuiltins.min + +.. autofunction:: ubuiltins.pow + +.. autofunction:: ubuiltins.round + +.. autofunction:: ubuiltins.sum + +Iterable-related functions +-------------------------- + +.. autofunction:: ubuiltins.all + +.. autofunction:: ubuiltins.any + +.. autofunction:: ubuiltins.enumerate + +.. autofunction:: ubuiltins.iter + +.. autofunction:: ubuiltins.len + +.. autofunction:: ubuiltins.map + +.. autofunction:: ubuiltins.next + +.. autofunction:: ubuiltins.reversed + +.. autofunction:: ubuiltins.sorted + .. autofunction:: ubuiltins.zip + +Conversion functions +------------------------ + +.. autofunction:: ubuiltins.bin + +.. autofunction:: ubuiltins.chr + +.. autofunction:: ubuiltins.hex + +.. autofunction:: ubuiltins.oct + +.. autofunction:: ubuiltins.ord + +.. autofunction:: ubuiltins.repr + +Class-related functions +------------------------ + +.. autofunction:: ubuiltins.callable + +.. autofunction:: ubuiltins.classmethod + +.. autofunction:: ubuiltins.dir + +.. autofunction:: ubuiltins.getattr + +.. autofunction:: ubuiltins.hasattr + +.. autofunction:: ubuiltins.isinstance + +.. autofunction:: ubuiltins.issubclass + +.. autofunction:: ubuiltins.setattr + +.. autofunction:: ubuiltins.staticmethod + +.. autofunction:: ubuiltins.super + +Input/output functions +------------------------ + +.. autofunction:: ubuiltins.input + +.. autofunction:: ubuiltins.print + + +Runtime-related functions +------------------------- + +.. autofunction:: ubuiltins.locals + +.. autofunction:: ubuiltins.globals + +.. autofunction:: ubuiltins.eval + +.. autofunction:: ubuiltins.exec + +.. autofunction:: ubuiltins.hash + +.. autofunction:: ubuiltins.id + +.. autofunction:: ubuiltins.help