[Docs] Added callback signatures to AppBar doc. #3449
Conversation
|
Thanks for picking this up, it's really appreciated! 👍 Unless I'm mistaken you can use markdown, so in general, when referring to a another prop or component, you can wrap it in backticks Otherwise, looks great! |
|
Ok, I'll make those changes. Thanks! |
| @@ -105,16 +105,22 @@ const AppBar = React.createClass({ | |||
|
|
|||
| /** | |||
| * Callback function for when the left icon is selected via a touch tap. | |||
| * | |||
| * @param {object} event TouchTap event targeting the left `IconButton`. | |||
There was a problem hiding this comment.
could you rename object to Event please? thanks 😁
There was a problem hiding this comment.
Yeah, that's no problem; I was just going by the convention being used here.
There was a problem hiding this comment.
oh, well anyway it doesn't matter, either way we'll have to come up with better conventions anyway. I mean these aren't real events anyway they are SyntheticEvents that React creates. I wouldn't bother anyway. we'll have to discuss this further. keep it as it is for now 👍
There was a problem hiding this comment.
Ah ok, thanks :)
[Docs] Added callback signatures to AppBar doc.
|
Thanks a lot @theosherry |
#3191 and #3096
I'll continue working through the rest on the list if these look OK.