feat[DSS7]: Document SELF_REFRESH and ALWAYS_ON_DISPLAY properties - #760
feat[DSS7]: Document SELF_REFRESH and ALWAYS_ON_DISPLAY properties#760devarsht wants to merge 1 commit into
Conversation
github-actions
Bot
assigned
devarsht,
gehariprasath,
praneethbajjuri,
r-vignesh and
uditkumarti
StaticRocket
left a comment
StaticRocket
left a comment
There was a problem hiding this comment.
There's also some unnecessary use of passive voice in here
|
Don't have any comments, looks good to me. |
Add the SELF_REFRESH (plane) and ALWAYS_ON_DISPLAY (crtc) DRM properties to the tidss properties table, along with usage sections describing their behaviour and modetest examples, following the format used for the other documented properties. Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
@StaticRocket Yeah but re-reading those sentences which vale reported, those sentences look very much understandable/readable to me and I would prefer to keep that way. But if it's a more popular opinion to always use active voice I can always modify. |
|
Technical documentation is normally declarative and uses active voice. As an example of what I mean: We are dictating the way something behaves under optimal conditions. We are not writing to a friend about something that may or may not happen due to circumstance. It makes it dry, but brief, easier to translate, and usually easier to understand. |
|
You're also bugging commit-check with that patch formatting |
8 participants
Add the SELF_REFRESH (plane) and ALWAYS_ON_DISPLAY (crtc) DRM properties to the tidss properties table, along with usage sections describing their behaviour and modetest examples, following the format used for the other documented properties.