search

flauc / angular2-notifications

A light and easy to use notifications library for Angular.
https://stackblitz.com/edit/angular2-notifications-example
MIT License
746 stars 167 forks source link

README: Creating Notifications section outdated #385

Open Chealer opened 2 years ago

Chealer commented 2 years ago

The README's Creating Notifications section contains a table with method signatures like the following: success(title: any, content?: any, override?: any, context?: any)

At least the first 7 entries are outdated, as the title argument is now optional. Additionally, a set(notification: Notification, to: boolean): Notification method is not documented.

By the way:

  1. "This are the currently available access methods:" should read "These are the currently available access methods:".
  2. Most descriptions refer to "the provided title and content", when providing both is in fact optional.