Skip to content
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.

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

Add special rendering for deprecated operations #290

Merged
merged 2 commits into from
Jul 4, 2017
Merged

Add special rendering for deprecated operations #290

merged 2 commits into from
Jul 4, 2017

Conversation

pgolm
Copy link
Contributor

@pgolm pgolm commented Jul 1, 2017

This PR adds visual hints to deprecated operations which discussed in #286.

bildschirmfoto 2017-07-01 um 11 13 05

@RomanHotsiy
Copy link
Member

Looks awesome! Thanks for kicking it off @pgolm. Sorry for long reply.

Just one thing. Could you instead of adding label Warning: Depratecated add deprecated class to operation header just same way as you did here https://github.com/Rebilly/ReDoc/pull/290/files#diff-74068f897e8aeb7897a9b86c3d9cba68R3.
Then using this class and :after pseudo-selector add orange badge Deprecated to the end of the header. + maybe make header line-crossed too.
I think it will look better. What do you think?

@pgolm
Copy link
Contributor Author

pgolm commented Jul 3, 2017

Thanks for your review. Sounds very good to me 👍. I will change it later these day.

@pgolm
Copy link
Contributor Author

pgolm commented Jul 4, 2017

I've added the deprecated badge to the header. But the strikethrough header looks a little bit to heavy for me, so i left it. Any thoughts?

bildschirmfoto 2017-07-04 um 07 30 53

Copy link

@SebastianStehle SebastianStehle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Btw: You can also use [class.deprecated]="options.deprecated"

@pgolm
Copy link
Contributor Author

pgolm commented Jul 4, 2017

Thanks for the hint @SebastianStehle. I didn't know that. In the source i can't find any usage of it. Are there any best practice?

@RomanHotsiy
Copy link
Member

@pgolm oh my... It's so huuuge 😂

I will merge this PR and then change the style of the badge myself if you don't mind

@pgolm
Copy link
Contributor Author

pgolm commented Jul 4, 2017

@RomanGotsiy 🙈👍

@RomanHotsiy RomanHotsiy merged commit 2748aac into Redocly:master Jul 4, 2017
@RomanHotsiy
Copy link
Member

RomanHotsiy commented Jul 4, 2017

image

I believe it looks a bit better this way :)

Will release a new version till the end of the week.

@ssteeg-mdsol
Copy link

Thanks for adding this feature, will it be released soon?

@RomanHotsiy
Copy link
Member

Yes, will cut a new release until the end of this week!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants