Skip to content
This repository has been archived by the owner on Sep 30, 2020. It is now read-only.

feat: enforce deprecation notices to contain version names #55

Closed
jbalsas opened this issue Jul 31, 2019 · 2 comments · Fixed by #175
Closed

feat: enforce deprecation notices to contain version names #55

jbalsas opened this issue Jul 31, 2019 · 2 comments · Fixed by #175
Labels

Comments

@jbalsas
Copy link
Contributor

jbalsas commented Jul 31, 2019

As requested at brianchandotcom/liferay-portal#76327 (comment), when tagging classes/methods with the @deprecated annotation, we should always include the version names of the product.

/**
 * The Storage Formatter Utility
 *
 * @deprecated since 7.3, replaced by Liferay.Util.formatStorage
 * @module liferay-storage-formatter
 */

Can you SF enforce the versions so they contain Athanasius /Mueller etc. Thx!

wincent referenced this issue in brianchandotcom/liferay-portal Apr 21, 2020
@wincent
Copy link
Contributor

wincent commented Apr 21, 2020

Here's another example:

Incorrect code:

/**
 * @deprecated as of 7.3 - use `window.innerWidth` instead
 */

Correct code:

/**
 * @deprecated As of Athanasius (7.3.x), replaced by `window.innerWidth`
 */

@wincent
Copy link
Contributor

wincent commented Apr 21, 2020

Examples showing valid version specifiers from liferay-portal:

* @deprecated As of Wilberforce (7.0.x)
* @deprecated As of Wilberforce (7.0.x), replaced by {@link
* @deprecated As of Wilberforce (7.0.x), with no direct replacement
* @deprecated As of Judson (7.1.x)
* @deprecated As of Judson (7.1.x), replaced by {@link
* @deprecated As of Judson (7.1.x), with no direct replacement
* @deprecated As of Mueller (7.2.x)
* @deprecated As of Mueller (7.2.x), replaced by {@link
* @deprecated As of Mueller (7.2.x), with no direct replacement
* @deprecated As of Athanasius (7.3.x)
* @deprecated As of Athanasius (7.3.x), replaced by {@link
* @deprecated As of Athanasius (7.3.x), with no direct replacement

@wincent wincent changed the title Enforce deprecation notices to contain version names feat: enforce deprecation notices to contain version names Apr 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants