@tsteur opened this Pull Request on August 6th 2015 Owner

refs #7837

A pull request for the documentation is here: https://github.com/piwik/developer-documentation/pull/100

Ideally we would merge documentation before this as I added some links to those docs. We can close #7837 once both are merged

@mnapoli commented on August 6th 2015 Member

Deprecated tags can take the reason inline, this is useful so that tools can show the reason why something is deprecated. E.g. in PhpStorm you get a warning when using something deprecated, and at the same time you see the message. Additionally, it's simpler and less confusing (an empty <a class='mention' href='https://github.com/deprecated'>@deprecated</a> can be very confusing because it doesn't tell you what to do next).

Example, from this:

/**
 * This event is deprecated, use [Dimensions](http://developer.piwik.org/guides/dimensions) instead.
 *
 * <a class='mention' href='https://github.com/deprecated'>@deprecated</a>
 */

to this:

/**
 * <a class='mention' href='https://github.com/deprecated'>@deprecated</a> Use [Dimensions](http://developer.piwik.org/guides/dimensions) instead.
 */
@tsteur commented on August 6th 2015 Owner

I didn't wanna do this as we do not show this message behind <a class='mention' href='https://github.com/deprecated'>@deprecated</a> in the docs on developer.piwik.org. In this case I only want to have the docs for this deprecated message on developer.piwik.org. There is no auto completion for events anyway in PHPStorm etc

@diosmosis commented on August 20th 2015 Member

@tsteur Can you rebase? Will merge both branches when done.

@tsteur commented on August 21st 2015 Owner

Rebased it and will merge now

This Pull Request was closed on August 21st 2015
Powered by GitHub Issue Mirror