Zulip Chat Archive
Stream: mathlib4
Topic: No docstring for structure
Yaël Dillies (Jan 23 2024 at 15:05):
I just found out that docs#Ring has no docstring! What happened there? :face_with_raised_eyebrow:
Martin Dvořák (Jan 23 2024 at 15:18):
I quickly skimmed the Git history of the Mathlib4 repo. It seems that the docstring was never there.
Yaël Dillies (Jan 23 2024 at 15:19):
What does docs3#ring say?
Yaël Dillies (Jan 23 2024 at 15:20):
It does have a docstring there. A porting misshap?
Ruben Van de Velde (Jan 23 2024 at 15:22):
I think Ring
was ad-hoc ported really early
Jireh Loreaux (Jan 23 2024 at 16:56):
Oof, that hurts. I wonder how many docstrings we're missing as a result of that.
Mario Carneiro (Jan 23 2024 at 17:20):
we have a nolints.json which is supposed to be tracking this, but it seems to have grown a bit out of control during the port and we haven't taken the time to work it down again
Matthew Ballard (Jan 23 2024 at 17:21):
What happens if you replace with a blank copy?
Mario Carneiro (Jan 23 2024 at 17:23):
you get a ton of linter warnings that stop the build?
Mario Carneiro (Jan 23 2024 at 17:24):
It was recently trimmed down to only the ones that are still applicable in #9832
Mario Carneiro (Jan 23 2024 at 17:24):
so all of the remaining ones should be true positives
Yaël Dillies (Jan 23 2024 at 17:59):
Glad to know that the linter is doing its job, at least.
Matthew Ballard (Jan 23 2024 at 19:34):
I took a stab at this #9941 Have at it :)
Yaël Dillies (Jan 23 2024 at 19:59):
Ah, I just opened #9942 !
Matthew Ballard (Jan 23 2024 at 20:01):
That’s certainly more thorough
Last updated: May 02 2025 at 03:31 UTC