-
-
Notifications
You must be signed in to change notification settings - Fork 64
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
Add NotifyPropertyChanged, PropertyChangedListener #18
Conversation
Hi, |
Also please bump the Line 36 in b8b8b93
to <2.10@dev .
|
c588b4c
to
0a45b42
Compare
@Majkl578 This time, I ran |
Nice, thanks. 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly documentation wording improvements needed. These classes are tricky to describe, so we should be careful about what we're writing in here.
namespace Doctrine\Common; | ||
|
||
/** | ||
* Contract for classes that are potential listeners of a <tt>NotifyPropertyChanged</tt> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use {@see MyClass}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The cyclical dependency of these classes is a bit hard to grasp: can we add another sentence or two that don't involve explaining this with NotifyPropertyChanged
in mind?
interface PropertyChangedListener | ||
{ | ||
/** | ||
* Notifies the listener of a property change. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Collect information about a property change"
0a45b42
to
de0c5f8
Compare
@Ocramius I'd personally prefer doing such changes in separate PR, leaving this only a move stuff from X to Y. |
I second that :) |
If it's got to be committed, and it counts as an addition, let's use the chance to improve that. We all know very well that otherwise it just lands in the endless wastelands of "I wish we did also X". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @Majkl578 here. Wording improvements are one thing, but this feature needs comprehensive documentation anyways. This can be copied from the "Change tracking policies" sections of the ORM and MongoDB ODM docs and adapted to be generic, but this functionality isn't something we can easily explain in the docblock of an interface. As such, I'm 👍 merging it as is.
de0c5f8
to
8a296e4
Compare
I updated the dock-block with @alcaeus suggestion. |
8a296e4
to
5451e5e
Compare
5451e5e
to
0ca0ce6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, changes suggested by @Ocramius were addressed, as for the documentation itself let's do it in separate PR (extracting it from ORM/ODM docs).
Fix doctrine/common#855