Skip to content

Rename title to header #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
epage opened this issue Apr 25, 2024 · 2 comments
Open

Rename title to header #118

epage opened this issue Apr 25, 2024 · 2 comments
Labels
C-enhancement Category: enhancement M-breaking-change Meta: Implementing or merging this will introduce a breaking change S-triage Status: This issue is waiting on initial triage

Comments

@epage
Copy link
Contributor

epage commented Apr 25, 2024

This is inspired by #114 where someone wanted to include a lot of details in the "title" but assumed they couldn't.
@epage epage added C-enhancement Category: enhancement S-triage Status: This issue is waiting on initial triage labels Apr 25, 2024
@epage
Copy link
Contributor Author

epage commented Apr 25, 2024

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
Copy link
Contributor Author

epage commented Apr 25, 2024

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 epage mentioned this issue Apr 16, 2025
Open
epage added a commit to epage/annotate-snippets-rs that referenced this issue Apr 16, 2025
@epage
fix!: Rename Level::title/Level::message to Level::header
d3b79b6 
This doesn't completely take care of  rust-lang#118 because of rust-lang#196
@epage epage added the M-breaking-change Meta: Implementing or merging this will introduce a breaking change label Apr 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-enhancement Category: enhancement M-breaking-change Meta: Implementing or merging this will introduce a breaking change S-triage Status: This issue is waiting on initial triage
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@epage