Hide accidentally included stuff from the documentation (pyodide#5274)

Author: hoodmane

docs/sphinx_pyodide/sphinx_pyodide/jsdoc.py

@@ -101,7 +101,7 @@ def doclet_is_private(doclet: ir.TopLevel) -> bool:
         # this via a @private decorator in the documentation comment.
         return True
 
-    if filename in ["module.", "compat.", "types."]:
+    if filename in ["module.", "compat."]:
         return True
 
     if filename == "pyproxy." and toplevelname.endswith("Methods"):

docs/sphinx_pyodide/sphinx_pyodide/mdn_xrefs.py

@@ -32,6 +32,14 @@
         "TextDecoder": "$global/",
         "DataView": "$global/",
         "Uint8Array": "$global/",
+        "Int8Array": "$global/",
+        "Uint16Array": "$global/",
+        "Int16Array": "$global/",
+        "Uint32Array": "$global/",
+        "Int32Array": "$global/",
+        "Uint8ClampedArray": "$global/",
+        "Float32Array": "$global/",
+        "Float64Array": "$global/",
         "Map": "$global/",
         "Set": "$global/",
         # the JavaScript domain has no exception type for some reason...
@@ -156,11 +164,24 @@
             USE_NAME_AS_LINK_TEXT,
         )
 
-for key, url in [
-    ("void", "https://www.typescriptlang.org/docs/handbook/2/functions.html#void"),
-    ("any", "https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any"),
+for ty, key, url in [
+    (
+        "js:data",
+        "void",
+        "https://www.typescriptlang.org/docs/handbook/2/functions.html#void",
+    ),
+    (
+        "js:data",
+        "any",
+        "https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any",
+    ),
+    (
+        "js:class",
+        "Record",
+        "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
+    ),
 ]:
-    INVDATA["js:data"][key] = (
+    INVDATA[ty][key] = (
         "typescript docs",
         "",
         url,

src/js/api.ts

@@ -666,6 +666,11 @@ export class PyodideAPI {
     return orig;
   }
 
+  /**
+   *
+   * @param param0
+   * @returns
+   */
   static makeMemorySnapshot({
     serializer,
   }: {
@@ -732,6 +737,7 @@ API.bootstrapFinalizedPromise = new Promise<void>(
   (r) => (bootstrapFinalized = r),
 );
 
+/** @private */
 export function jsFinderHook(o: object) {
   if ("__all__" in o) {
     return;

src/js/dynload.ts

@@ -5,6 +5,7 @@ import { PackageManagerAPI, PackageManagerModule } from "./types";
 import { createLock } from "./common/lock";
 import { LoadDynlibFS, ReadFileType, InternalPackageData } from "./types";
 
+/** @hidden */
 export class DynlibLoader {
   #api: PackageManagerAPI;
   #module: PackageManagerModule;

src/js/installer.ts

@@ -9,6 +9,7 @@ import { PackageManagerAPI, PackageManagerModule } from "./types";
  * - storing metadata about the Package
  * - loading shared libraries
  * - installing data files
+ * @hidden
  */
 export class Installer {
   #api: PackageManagerAPI;

src/js/load-package.ts

@@ -6,6 +6,7 @@ import {
   PackageLoadMetadata,
   PackageManagerAPI,
   PackageManagerModule,
+  LoadedPackages,
 } from "./types";
 import { IN_NODE } from "./environments";
 import type { PyProxy } from "generated/pyproxy";
@@ -118,7 +119,7 @@ export class PackageManager {
    *
    * TODO: Make this private and expose a setter
    */
-  public loadedPackages: Record<string, string> = {};
+  public loadedPackages: LoadedPackages = {};
 
   private _lock = createLock();
 
@@ -566,7 +567,14 @@ export function toStringArray(str: string | PyProxy | string[]): string[] {
 }
 
 export let loadPackage: typeof PackageManager.prototype.loadPackage;
-export let loadedPackages: typeof PackageManager.prototype.loadedPackages;
+/**
+ * An object whose keys are the names of the loaded packages and whose values
+ * are the install sources of the packages. Use
+ * `Object.keys(pyodide.loadedPackages)` to get the list of names of loaded
+ * packages, and `pyodide.loadedPackages[package_name]` to access the install
+ * source for a particular `package_name`.
+ */
+export let loadedPackages: LoadedPackages;
 
 if (typeof API !== "undefined" && typeof Module !== "undefined") {
   const singletonPackageManager = new PackageManager(API, Module);

src/js/snapshot.ts

@@ -3,6 +3,7 @@ import { scheduleCallback } from "./scheduler";
 
 declare var Module: any;
 
+/** @private */
 export function getExpectedKeys() {
   return [
     null,
@@ -58,6 +59,9 @@ export function makeGlobalsProxy(
 
 type SerializedHiwireValue = { path: string[] } | { serialized: any } | null;
 
+/**
+ * @hidden
+ */
 export type SnapshotConfig = {
   hiwireKeys: SerializedHiwireValue[];
   immortalKeys: string[];
@@ -245,6 +249,7 @@ API.restoreSnapshot = function (snapshot: Uint8Array): SnapshotConfig {
  * This code is quite sensitive to the details of our setup, so it might break
  * if we move stuff around far away in the code base. Ideally over time we can
  * structure the code to make it less brittle.
+ * @private
  */
 export function syncUpSnapshotLoad1() {
   // hiwire init puts a null at the beginning of both the mortal and immortal tables.
@@ -275,6 +280,7 @@ function tableSet(idx: number, val: any): void {
 
 /**
  * Fill in the JsRef table.
+ * @private
  */
 export function syncUpSnapshotLoad2(
   jsglobals: any,

src/js/types.ts

@@ -171,22 +171,26 @@ declare global {
   export const __iscoroutinefunction: (a: number) => number;
 }
 
+/** @hidden */
 export type FSNode = {
   timestamp: number;
   rdev: number;
   contents: Uint8Array;
   mode: number;
 };
 
+/** @hidden */
 export type FSStream = {
   tty?: boolean;
   seekable?: boolean;
   stream_ops: FSStreamOps;
   node: FSNode;
 };
 
+/** @hidden */
 export type FSStreamOps = FSStreamOpsGen<FSStream>;
 
+/** @hidden */
 export type FSStreamOpsGen<T> = {
   open: (a: T) => void;
   close: (a: T) => void;
@@ -207,6 +211,7 @@ export type FSStreamOpsGen<T> = {
   ) => number;
 };
 
+/** @hidden */
 export interface FS {
   unlink: (path: string) => void;
   mkdirTree: (path: string, mode?: number) => void;
@@ -256,26 +261,30 @@ export interface FS {
   readFile(a: string): Uint8Array;
 }
 
-/** @private */
+/** @hidden */
 export type PreRunFunc = (Module: Module) => void;
 
+/** @hidden */
 export type ReadFileType = (path: string) => Uint8Array;
 
 // File System-like type which can be passed to
 // Module.loadDynamicLibrary or Module.loadWebAssemblyModule
+/** @hidden */
 export type LoadDynlibFS = {
   readFile: ReadFileType;
   findObject: (path: string, dontResolveLastLink: boolean) => any;
 };
 
 type DSO = any;
 
+/** @hidden */
 export interface LDSO {
   loadedLibsByName: {
     [key: string]: DSO;
   };
 }
 
+/** @hidden */
 export interface Module {
   API: API;
   locateFile: (file: string) => string;
@@ -340,11 +349,13 @@ type LockfileInfo = {
   python: string;
 };
 
+/** @hidden */
 export type Lockfile = {
   info: LockfileInfo;
   packages: Record<string, InternalPackageData>;
 };
 
+/** @hidden */
 export type PackageType =
   | "package"
   | "cpython_module"
@@ -361,6 +372,9 @@ export interface PackageData {
   packageType: PackageType;
 }
 
+/** @hidden */
+export type LoadedPackages = Record<string, string>;
+
 /**
  * @hidden
  */
@@ -388,6 +402,7 @@ export type PackageLoadMetadata = {
   packageData: InternalPackageData;
 };
 
+/** @hidden */
 export interface API {
   fatal_error: (e: any) => never;
   isPyProxy: (e: any) => e is PyProxy;