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

Deprecated some tracker events #8500

Merged
merged 1 commit into from Aug 21, 2015
Merged

Deprecated some tracker events #8500

merged 1 commit into from Aug 21, 2015

Conversation

tsteur
Copy link
Member

@tsteur tsteur commented Aug 6, 2015

refs #7837

A pull request for the documentation is here: matomo-org/developer-documentation#100

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

@tsteur tsteur added the Needs Review PRs that need a code review label Aug 6, 2015
@tsteur tsteur added this to the 2.15.0 milestone Aug 6, 2015
@tsteur tsteur added not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. labels Aug 6, 2015
@mnapoli
Copy link
Contributor

mnapoli commented Aug 6, 2015

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 @deprecated 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.
 *
 * @deprecated
 */

to this:

/**
 * @deprecated Use [Dimensions](http://developer.piwik.org/guides/dimensions) instead.
 */

@tsteur
Copy link
Member Author

tsteur commented Aug 6, 2015

I didn't wanna do this as we do not show this message behind @deprecated 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
Copy link
Member

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

@tsteur
Copy link
Member Author

tsteur commented Aug 21, 2015

Rebased it and will merge now

tsteur added a commit that referenced this pull request Aug 21, 2015
Deprecated some tracker events
@tsteur tsteur merged commit 28bda49 into master Aug 21, 2015
@tsteur tsteur deleted the 7838 branch August 21, 2015 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. Needs Review PRs that need a code review not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants