Skip to content

fix: stabilize python module order in typedoc snapshots #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vdusek merged 1 commit into from
May 26, 2026
Merged

fix: stabilize python module order in typedoc snapshots #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/plugin/python/transformation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,12 @@ export class DocspecTransformer {
docspecModules as unknown as { name: string },
);

// Sort modules by name so the sequential IDs assigned by `SymbolIdTracker` are deterministic across
// runs (`PythonLoader` traversal order is filesystem-dependent and reshuffles IDs across CI machines).
const sortedModules = [...docspecModules].sort((a, b) => a.name.localeCompare(b.name));

// Convert all the modules, store them in the root object
for (const module of docspecModules) {
for (const module of sortedModules) {
this.walkAndTransform({
currentDocspecNode: module,
moduleName: module.name,
Expand Down
Loading