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

(HDS-2157) Tag mark deprecated and changed properties #1234

Merged
merged 1 commit into from
Mar 6, 2024

Conversation

mrTuomoK
Copy link
Contributor

@mrTuomoK mrTuomoK commented Mar 3, 2024

Description

Tag mark deprecated and changed properties in the next major release.

Related Issue

HDS-2157

How Has This Been Tested?

  • local machine

Add to changelog

  • Added needed line to changelog

@mrTuomoK mrTuomoK requested a review from a team March 3, 2024 12:07
@NikoHelle
Copy link
Contributor

The Navigation component was deprecated with

/**
 * Navigation will be removed in the next major release. Upcoming Header component will be the replacement.
 * @deprecated
 */
export const Navigation = ({

This might be enough?

https://jsdoc.app/tags-deprecated

@mrTuomoK
Copy link
Contributor Author

mrTuomoK commented Mar 4, 2024

Hmm... didn't we agree not to deprecate the whole component? 🤔

@NikoHelle
Copy link
Contributor

Ah, true. Just replacing with new one.

@NikoHelle
Copy link
Contributor

But shouldn't we still mark the props deprecated?

https://dev.to/dgreene1/how-to-properly-deprecate-3027

Adding plain text to the props won't propably be seen anywhere unless devs actually follow type links or hover over a prop.

@mrTuomoK
Copy link
Contributor Author

mrTuomoK commented Mar 5, 2024

Ok let's see... I though I just copied the way Riippi did earlier :D

…or release.

(HDS-2157) Add @deprecated to props that will completely change or be removed
@mrTuomoK mrTuomoK force-pushed the HDS-2157-tag-deprecate-old-properties branch from 05fe189 to c95aa44 Compare March 5, 2024 12:06
@mrTuomoK
Copy link
Contributor Author

mrTuomoK commented Mar 5, 2024

Now it should be properly done @NikoHelle . @deprecated all which's use will completely be changed or completely removed, so didn't deprecate for example id since default value is the only thing that will change.

Copy link
Contributor

@laurakarhu laurakarhu left a comment

Choose a reason for hiding this comment

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

Making space for new shiny tag!

@mrTuomoK mrTuomoK merged commit 02479bc into development Mar 6, 2024
6 checks passed
@mrTuomoK mrTuomoK deleted the HDS-2157-tag-deprecate-old-properties branch March 6, 2024 06:55
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.

3 participants