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

permissions : docBlock #5972

Merged
merged 2 commits into from
Mar 14, 2014
Merged

permissions : docBlock #5972

merged 2 commits into from
Mar 14, 2014

Conversation

jmleroux
Copy link
Contributor

update docblock documentation

@@ -110,6 +110,7 @@ public function getRole($objectOrName)

$it = new RecursiveIteratorIterator($this, RecursiveIteratorIterator::CHILD_FIRST);
foreach ($it as $leaf) {
/* @var RoleInterface $leaf */
Copy link
Contributor Author

Choose a reason for hiding this comment

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

For IDE autocomplete

Copy link
Member

Choose a reason for hiding this comment

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

I think that is suppose to be /** @var RoleInterface $leaf */
when used inline, at least that i how PHPStorm does it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I use PHPStorm and it actually use /**.
But it also understand /* and since Eclipse seems to prefer this last syntax, i thought it would be better.

Copy link
Member

Choose a reason for hiding this comment

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

Really I prefer Docblock comment block syntax since @var is traditionally used in docblocks.

Copy link
Member

Choose a reason for hiding this comment

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

Anyway this detail is not enough for do a change (even do a PR for this things)

@@ -127,6 +128,7 @@ public function getRole($objectOrName)
* @param RoleInterface|string $role
* @param string $permission
* @param AssertionInterface|Callable|null $assert
Copy link
Contributor

Choose a reason for hiding this comment

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

You missed 1 more space to align with the @throws Exception\InvalidArgumentException as well :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👽 A little bit fussy on this one ! ^^

Copy link
Contributor

Choose a reason for hiding this comment

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

Well, your PR aims to fix docblock 😄

Copy link
Member

Choose a reason for hiding this comment

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

@danizord Alignment is not a valid reason for change a PR.

Maks3w added a commit that referenced this pull request Mar 14, 2014
Maks3w added a commit that referenced this pull request Mar 14, 2014
Maks3w added a commit that referenced this pull request Mar 14, 2014
@Maks3w Maks3w merged commit 0cc76e0 into zendframework:master Mar 14, 2014
@jmleroux jmleroux deleted the permissions-doc branch March 15, 2014 22:30
weierophinney pushed a commit to zendframework/zend-permissions-rbac that referenced this pull request May 15, 2015
weierophinney pushed a commit to zendframework/zend-permissions-rbac that referenced this pull request May 15, 2015
weierophinney pushed a commit to zendframework/zend-permissions-rbac that referenced this pull request May 15, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants