annotate-snippets-rs icon indicating copy to clipboard operation
annotate-snippets-rs copied to clipboard

Rename `title` to `header`

Open epage opened this issue 1 year ago • 2 comments

This is inspired by #114 where someone wanted to include a lot of details in the "title" but assumed they couldn't.

epage avatar Apr 25 '24 00:04 epage

If we decided to do this, we can do it without a breaking change with the current API because we can add a new function and deprecate the old one.

epage avatar Apr 25 '24 00:04 epage

Alternatively, from #114

It's much more intuitive for me when constructor methods are named after the thing they construct (unless they construct Self, in which case some variant of "new" or "from"). So I'd personally name that method "message" and call its parameter "header".

epage avatar Apr 25 '24 00:04 epage