Skip to content

Fix param docs for PropertyAccessor read method #7498

Closed
wants to merge 2 commits into from

3 participants

@jmikola
jmikola commented Mar 27, 2013
Q A
Fixed tickets none
License MIT
@fabpot fabpot and 2 others commented on an outdated diff Mar 27, 2013
...omponent/PropertyAccess/PropertyAccessorInterface.php
@@ -72,8 +72,8 @@ public function setValue(&$objectOrArray, $propertyPath, $value);
*
* If none of them are found, an exception is thrown.
*
- * @param object|array $objectOrArray The object or array to traverse
- * @param string|PropertyPathInterface $propertyPath The property path to modify.
+ * @param object|array $objectOrArray The object or array to traverse.
+ * @param string|PropertyPathInterface $propertyPath The property path to read.
@fabpot
Symfony member
fabpot added a note Mar 27, 2013

Can you remove the dots at the end of this line and the line above?

@jmikola
jmikola added a note Mar 27, 2013

I took a look through the component and noticed there were many trailing periods. bdb8473 should catch them all.

@lazyhammer
lazyhammer added a note Mar 27, 2013

AFAIK, you should not fix coding style for the existing code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@jmikola jmikola [PropertyAccess] Remove trailing periods from doc blocks
Periods were left in place for entries with multiple sentences/statements.
bdb8473
@fabpot
Symfony member
fabpot commented Mar 28, 2013

Can you submit this PR on the 2.2 branch instead?

@jmikola
jmikola commented Mar 28, 2013

Ah, yes. Didn't realize that master was already for 2.3.

@jmikola jmikola closed this Mar 28, 2013
@fabpot fabpot added a commit that referenced this pull request Mar 28, 2013
@fabpot fabpot merged branch jmikola/2.2-propertyaccess-docs (PR #7511)
This PR was merged into the 2.2 branch.

Discussion
----------

[PropertyAccess] Documentation cleanup

| Q             | A
| ------------- | ---
| Fixed tickets | none
| License       | MIT

Resubmission of #7498

Commits
-------

8aaa6ef [PropertyAccess] Remove trailing periods from doc blocks
d78fec9 Fix param docs for PropertyAccessor read method
92501eb
@mmucklo mmucklo pushed a commit that referenced this pull request May 23, 2013
@fabpot fabpot merged branch jmikola/2.2-propertyaccess-docs (PR #7511)
This PR was merged into the 2.2 branch.

Discussion
----------

[PropertyAccess] Documentation cleanup

| Q             | A
| ------------- | ---
| Fixed tickets | none
| License       | MIT

Resubmission of #7498

Commits
-------

8aaa6ef [PropertyAccess] Remove trailing periods from doc blocks
d78fec9 Fix param docs for PropertyAccessor read method
223c1c7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.