Zulip Chat Archive

Stream: lean4

Topic: register_simp_attr requires a docstring?


François G. Dorais (Sep 22 2022 at 21:58):

It looks like the register_simp_attr command now requires a docstring after the string description argument was dropped from the command syntax (a while ago on September 9). Is this intentional? It's not a bad idea to encourage good documentation but it caught me by surprise that it's _required_ in this case.

Mario Carneiro (Sep 22 2022 at 22:04):

it's because the string description argument is being taken from the doc string now

Mario Carneiro (Sep 22 2022 at 22:06):

that's a required argument, we just changed how you input it to make it easier to do long-form descriptions

Mario Carneiro (Sep 22 2022 at 22:07):

We could make the description optional though, just use "" or something

François G. Dorais (Sep 22 2022 at 22:12):

Ah! That makes sense. Making it optional seems like a good idea since it's pretty weird to require a comment as part of the syntax.


Last updated: Dec 20 2023 at 11:08 UTC