Enable help('modules') in unix & windows. Hint to help('modules'). #2906
Conversation
…help text.
This enables listing all builtin modules by calling `help('modules')` in the
unix and windows ports.
It also adds a hint to this functionality to the default help text, if the
functionality is built into a port.
The esp8266 was similarly ammended.
ARF1
force-pushed
the
enable_help_modules_unix_windows
branch
2 times, most recently
from
9a0dcc0 to
f1facfd
Compare
|
We generally fight to make things smaller, not bigger. This contradicts #2908, so even if it's added, would need to be removed as the next step. |
|
@pfalcon Of course it up to you. I clearly do not yet fully understand this projects philosophy. I understand keeping things compact with regard to MCU use:
|
This disables the help in the unix port by default but keeps the configuration option in place to allow users to enable it if desired.
ARF1
force-pushed
the
enable_help_modules_unix_windows
branch
from
c205507 to
3668da5
Compare
But I definitely like your approach, at the "high level" at least. But (and I see that oftentimes), I don't see these "high level ideas" leading to the (obvious) outcomes. For example, you understand that (1) understanding a project philosophy is crucial to be able to contribute to it productively, what would be the outcome of that? Of course, it would be the looking to update oneself on that philosophy. And of course, any sufficiently advanced project would know a proposition (1) itself, and provide materials for that, as it's in project's best interest to get more useful contributions. In MicroPython case, anyone who tries to submit a bug ticket or pull request is presented with a link describing the project philosophy: https://github.com/micropython/micropython/wiki/ContributorGuidelines . So, you had a chance to read it half-dozen of times already. |
| #define MICROPY_PY_BUILTINS_COMPILE (1) | ||
| #define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (1) | ||
| #define MICROPY_PY_BUILTINS_POW3 (1) | ||
| #if !defined(MICROPY_PY_BUILTINS_HELP) |
There was a problem hiding this comment.
Please do this idiom the same way it's already done in this file (hint: #ifndef, no indent).
How would that help? Novices aren't going to use MicroPython on big systems, because they cay use CPython there. Only advanced users, interested in much smaller size of MicroPython, would run it there. And being smaller is exactly the property being compromised with this patch. So, please make necessary changes, please squash everything together, and please update commit message and PR title to be current. Thanks. |
|
Well, I'm giving this yet another try of being merged right away. As can be seen, previous time what stopped me is many inconsistencies in the current patch. Given that I don't anticipate anything but "Hint to help('modules')." part to be merged from this (as my personal opinion), I'm giving another try to merge just that part. And then what I see is: Well, we never paid attention to such things before, and we definitely have commits with non-real-names and not-valid-emails, but it's really the first time I see it done like that. So, please consider using the real name and real email address as most of the other people do. For the lack of more explicit forms of sign-off (we don't require signing contribution agreement on paper and even don't require git's Signed-off-by), contributor's act of submitting a pull request to the project construes their agreement with the project license and principles. Please make sure that your signature on that document is clear and legible. |
See related #1354, #2906, #3436. Signed-off-by: Damien George <[email protected]>
|
This was done in 6430cd3 |
3 participants
This enables the help in the unix and windows ports.
Listing all builtin modules by calling
help('modules')is enabled and a hint to this functionality is added to the default help text, if the functionality is built into a port.The esp8266 help text was similarly amended.
Default help() message with modules help enabled: