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

Improve deprecation styling #677

Open

orhun opened this issue Aug 8, 2024 · 1 comment

Labels

Member

orhun commented Aug 8, 2024

We currently use diffs for deprecated elements in highlights like so:

- Axis::default().labels(vec!["a".into(), "b".into()])
+ Axis::default().labels(["a", "b"])

I was reading goreleaser docs (don't ask why) and realized they have this special tab view for old/new variants of deprecated elements:

See https://goreleaser.com/deprecations/#build

We can probably do something like this as well :)

Member

joshka commented Aug 9, 2024

This would require tabs support in GitHub flavored markdown. There's a feature request that's been open for a few years for that https://github.com/orgs/community/discussions/14964

We could probably special case it for the website, but it would still need a markdown friendly format for general use.

orhun added the enhancement label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment