search

sendinblue / APIv3-nodejs-library

SendinBlue's API v3 Node.js Library
ISC License
101 stars 47 forks source link

some symbols in docs are unreadable #93

Closed dyllandry closed 3 years ago

dyllandry commented 3 years ago

So far docs have been a pleasure to read, but on this page https://github.com/sendinblue/APIv3-nodejs-library/blob/master/docs/CreateContact.md the description of some properties are encoded funny.

Example:

Properties

Name Type Description Notes
email String Email address of the user. Mandatory if \"SMS\" field is not passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"SMS\":\"0091xxxxxxxxxx\"} [optional]
attributes Object Pass the set of attributes and their values. These attributes must be present in your SendinBlue account. For eg. {\"FNAME\":\"Elly\", \"LNAME\":\"Roger\"} [optional]

(The table continues on the page.)

shubhamUpadhyayInBlue commented 3 years ago

Hello @dyllandry Thanks for pointing this out. I have reviewed your PR and will merge and publish it tomorrow. Also, this needs to be fixed in a few more places that I will take care of in our monthly update.

Tag for this change: https://github.com/sendinblue/APIv3-nodejs-library/releases/tag/v8.1.1 Thanks!