8000 DX: replace @link with @see annotation by keradus · Pull Request #20506 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

DX: replace @link with @see annotation #20506

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 15, 2016
Merged

DX: replace @link with @see annotation #20506

merged 1 commit into from
Nov 15, 2016

Conversation

keradus
Copy link
Member
@keradus keradus commented Nov 13, 2016
Q A
Branch? 2.7
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Tests pass? n/a
Fixed tickets n/a
License MIT
Doc PR n/a

Just to standardise.

λ grep -r "* @see " src | wc -l
    360

λ grep -r "* @link " src | wc -l
     12

@javiereguiluz javiereguiluz added the DX DX = Developer eXperience (anything that improves the experience of using Symfony) label Nov 13, 2016
linaori
linaori approved these changes Nov 14, 2016
View reviewed changes
Copy link
Contributor
@linaori linaori left a comment

Choose a reason for hiding this comment

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

Did you check if 2.8, 3.1 or 3.2 have added any new @links? I don't think so but would be nice to verify.

Status: reviewed

@keradus
Copy link
Member Author
keradus commented Nov 14, 2016

Nope. As with all other CS fixes, it should be applied to lowest supported branch and then, after having it marge to successors, could be rerun on following branches.

@fabpot
Copy link
Member
fabpot commented Nov 15, 2016

Thank you @keradus.

@fabpot fabpot merged commit f7326c1 into symfony:2.7 Nov 15, 2016
fabpot added a commit that referenced this pull request Nov 15, 2016
@fabpot
minor #20506 DX: replace @link with @see annotation (keradus)
a1afa21 
This PR was merged into the 2.7 branch.

Discussion
----------

DX: replace @link with @see annotation

| Q             | A
| ------------- | ---
| Branch?       | 2.7
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | n/a
| Fixed tickets | n/a
| License       | MIT
| Doc PR        | n/a

Just to standardise.

```console
λ grep -r "* @see " src | wc -l
    360

λ grep -r "* @link " src | wc -l
     12
```

Commits
-------

f7326c1 DX: replace @link with @see annotation
@fabpot
Copy link
Member
fabpot commented Nov 15, 2016

hmm, I've merged this one but not sure it was a good idea. @link is used a lot inside some phpdocs.

@keradus keradus deleted the 2.7_lint2see branch November 16, 2016 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@linaori linaori linaori approved these changes

Assignees
No one assigned
Labels
DX DX = Developer eXperience (anything that improves the experience of using Symfony) Status: Needs Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@keradus @fabpot @linaori @javiereguiluz @carsonbot
0