[DRAFT / WIP - DO NOT MERGE] Show filtered builtins documentation by microbit-robert · Pull Request #1174 · microbit-foundation/python-editor-v3
Conversation
Also allows links to the builtins from autocomplete and signature help where documentation is available.
Using type stubs from microbit-foundation/micropython-microbit-stubs#101
To discuss:
- Maybe we should filter out API docs for builtin classes where we don't show any methods as they are filtered out as
__new__ - Add some kind of indicator that not all classes, class methods and functions are documented in the builtins section
Notes from Matt:
- I've exempted
__new__but not convinced about exposing__new__vs__init__complexity to our users. But hard to mask it too... for str and list at least they do need to understand it as an object with methods. - Very weird to see range() three times because of overloads that exist for invisible type-related reasons. Same applies to constructors.
- The base class names are likely too scary for our users
- Lots of useful functions that are worth adding if everyone's happy with the idea (e.g. min, max)
Also allows links to the builtins from autocomplete and signature help where documentation is available.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
