inkdropapp/docs-old

Creating notifications should be documented better

Closed this issue · 1 comments

jmerle commented

It took me a while of going through the Inkdrop source code (well, a beautified version of the code in the asar archive) to find out that the docs to show notifications are incomplete.

Apparently the following does not show a notification:

inkdrop.notifications.addInfo('Hello world!');

While the following does:

inkdrop.notifications.addInfo('Hello world!', { dismissable: true });

The dismissable option is not documented anywhere but seems to be a requirement for the notification to show up to the user. I don't know if this is expected behavior or if it's a bug, but if it's the way it's supposed to work I guess this should be made clear in the docs.

craftzdog commented

Seems like a bug that the app always expects dismissable: true because of the incomplete implementation when I borrowed some code from Atom Editor.
Sorry for the trouble!
Will fix it in the next release and update the doc.

  • 👍1