Edits in Motoko base library docs


While going through the Motoko base library docs:

I’ve noticed a few things that seem to all be caused by the auto-generation of those pages:

1 - Lots of the pages include references to ‘values’ that hold functions. While they are defined as values in the source code, and are thus technically correct, you might want to consider if it makes more sense to developers to just use the ‘value’ label for those values that hold static primitives, while calling those values that hold functions as functions.

e.g. Int8 | Internet Computer

2 - The ‘Edit this page’ links at the bottom point to missing pages on Github

e.g. The link at the bottom of:

points to:

I’m not sure if there are other ‘Edit this page’ links that are inaccurate outside the base library docs, but you might want to double-check them where the docs have been moved on Github.

3 - Where public functions are defined within another function (e.g. as an object method), the internal function is also listed in the links on the top-right.

e.g. On this page:

there’s a next() function defined twice for both class range and revRange, when really they probably don’t want to be there at all, as well as the auto-generated docs.

4 - Some base library features are undocumented

e.g. Array - functions after subArray() are undocumented
e.g. None - not yet documentated

Just thought I’d pass these along.

Sorry about that… It’s because these pages are submodules and the logic that adds the ‘Edit this page’ button can’t really pick up on that. I’ll see if the website team could have an idea


Thanks, I’ll open some issues…

1 Like