Skip to content

Missing module docstrings + type_of% theorem links#3579

Merged
mo271 merged 2 commits intogoogle-deepmind:mainfrom
mo271:missing_module_docstrings
Mar 20, 2026
Merged

Missing module docstrings + type_of% theorem links#3579
mo271 merged 2 commits intogoogle-deepmind:mainfrom
mo271:missing_module_docstrings

Conversation

@mo271
Copy link
Collaborator

@mo271 mo271 commented Mar 15, 2026

No description provided.

@mo271 mo271 enabled auto-merge (squash) March 15, 2026 21:47
@mo271 mo271 requested review from Paul-Lez and YaelDillies March 19, 2026 23:45
Copy link
Member

@YaelDillies YaelDillies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we reduce the maintenance load by not duplicating the module docs?

@mo271
Copy link
Collaborator Author

mo271 commented Mar 20, 2026

My feeling is that right now that affects really only quite a few problems and before this pull request it was incosistent: sometime we had an extra module doc other files were just empty other than one line of import.
I changed the fewer files so that now every file has exactly one module docstring.
But I'm happy also to go the other way: but then for some of them it is a bit awkward to include both the formulation from Wikipedia and the one from erdosproblems.com (for instance).
I think the important thing is to make the problems findable: so good to have strings like "Hadwiger" both inside the files, but perhaps also good have them as filenames.

If we decide to do it differently I suggest to create an issue or just do it as a follow up? This doesn't affect the "WrittenOnTheWall" stuff here.

@YaelDillies
Copy link
Member

My concern is to reduce maintenance burden as much as possible. What about we make the module docs of the mirror files be just "This file points to the canonical formalization in"? I believe variations of the same problem should be discussed within a single file, rather than the discussion being split across several files.

@mo271 mo271 merged commit 1334a82 into google-deepmind:main Mar 20, 2026
6 checks passed
@mo271
Copy link
Collaborator Author

mo271 commented Mar 20, 2026

My concern is to reduce maintenance burden as much as possible. What about we make the module docs of the mirror files be just "This file points to the canonical formalization in"? I believe variations of the same problem should be discussed within a single file, rather than the discussion being split across several files.

Will do that in a follow up

@mo271
Copy link
Collaborator Author

mo271 commented Mar 20, 2026

#3608

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants