Zulip Chat Archive

Stream: mathlib4

Topic: Docstring style?


Thomas Murrills (Nov 18 2022 at 00:16):

I could have sworn I'd seen something somewhere specifying the style convention for docstrings—things like don't restate the type, use present tense, etc. I can't seem to find that anymore. Does anyone know if this exists somewhere?

Scott Morrison (Nov 18 2022 at 00:22):

I suspect the best you'll find is https://leanprover-community.github.io/contribute/style.html

Mario Carneiro (Nov 18 2022 at 00:39):

there is a lean 4 core issue by Patrick Massot about the style guide

Mario Carneiro (Nov 18 2022 at 00:52):

lean4#1461


Last updated: Dec 20 2023 at 11:08 UTC