From 1fab46e67ffaba28aee9d48d8b659b9d00ecf2c2 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Wed, 14 Jul 2021 10:16:58 +0200 Subject: [PATCH] doc/main/index: Clean up menu and builtins. There is no ubuiltins module, so we shouldn't mention it. Also reduce size of other module titles so they fit on one line in the menu. This makes it easier to read and get an overview. --- doc/api/index.rst | 4 ++-- doc/api/ubuiltins.rst | 2 +- doc/api/urandom.rst | 2 +- src/ubuiltins/__init__.py | 5 +---- 4 files changed, 5 insertions(+), 8 deletions(-) diff --git a/doc/api/index.rst b/doc/api/index.rst index 45603a4..f95c639 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -74,11 +74,11 @@ findings on our `support page`_ so we can make Pybricks even better. .. toctree:: :maxdepth: 1 - :caption: Additional Modules + :caption: MicroPython Modules :hidden: - micropython ubuiltins + micropython uerrno uio umath diff --git a/doc/api/ubuiltins.rst b/doc/api/ubuiltins.rst index 904e63f..521a3f6 100644 --- a/doc/api/ubuiltins.rst +++ b/doc/api/ubuiltins.rst @@ -1,4 +1,4 @@ -:mod:`ubuiltins` -- Built-in functions and exceptions +Built-in functions and exceptions ===================================================== .. automodule:: ubuiltins diff --git a/doc/api/urandom.rst b/doc/api/urandom.rst index 4d8909c..fe40ce9 100644 --- a/doc/api/urandom.rst +++ b/doc/api/urandom.rst @@ -1,4 +1,4 @@ -:mod:`urandom` -- Generate pseudo-random numbers +:mod:`urandom` -- Pseudo-random numbers ================================================ .. automodule:: urandom diff --git a/src/ubuiltins/__init__.py b/src/ubuiltins/__init__.py index ee9650b..237aa52 100644 --- a/src/ubuiltins/__init__.py +++ b/src/ubuiltins/__init__.py @@ -14,10 +14,7 @@ # Copyright (c) 2001-2021 Python Software Foundation """ -All builtin functions and exceptions are described here. They are also -available via ``ubuiltins`` module. - -.. tip:: Since these are built-in, you can (and should!) use them without importing. +The following functions and exceptions can be used without importing anything. """ from typing import (