search

slackhq / slack-api-docs

API Docs for Slack.com
https://api.slack.com/
426 stars 85 forks source link

Conflicting information on text in attachments #60

Closed dmitriid closed 8 years ago

dmitriid commented 8 years ago

Issue

Documentation contradicts itself

https://api.slack.com/docs/message-formatting#message_formatting

By default bot message text will be formatted, but attachments are not.

vs.

https://api.slack.com/docs/message-attachments

text This is the main text in a message attachment, and can contain standard message markup.

What happens

Text in attachments is displayed non-formatted despite what documentation for attachments says. This can be tested using the provided message builder (minimal example)

What should happen

One of:

  1. Documentation for message formatting should include details on how to enable text formatting in attachments. If not possible with current API, API should be updated to enable this
  2. Documentation on attachments should include a note saying when and how text is formatted in attachments.
ernesto-jimenez commented 8 years ago

It is documented :) From your first link:

By default bot message text will be formatted, but attachments are not. To disable formatting on a non-user message, set the mrkdwn property to false. To enable formatting on attachment fields, set the mrkdwn_in array on each attachment to the list of fields to process. Some examples:

Your second link points to the first one for message formatting.

On Mon, Aug 8, 2016 at 8:53 AM +0100, "dmitriid" notifications@github.com wrote:

Issue

Documentation contradicts itself

https://api.slack.com/docs/message-formatting#message_formatting

By default bot message text will be formatted, but attachments are not.

vs.

https://api.slack.com/docs/message-attachments

text

This is the main text in a message attachment, and can contain standard message markup.

What happens

Text in attachments is displayed non-formatted despite what documentation for attachments says. This can be tested using the provided message builder (minimal example)

What should happen

One of:

Documentation for message formatting should include details on how to enable text formatting in attachments. If not possible with current API, API should be updated to enable this

Documentation on attachments should include a note saying when and how text is formatted in attachments.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

dmitriid commented 8 years ago

Ah. Ooops :)

dmitriid commented 8 years ago

Thank you!

ahaverty commented 7 years ago

Also got confused about field formatting. A reference to the mrkdwn_in in the fields documentation would have been handy 🙌