Skip to content

Better documentation about slack_sdk.models usage in Web APIs #992

@seratch

Description

@seratch

We can improve the docstrings and the documentation website to provide more information about models.


Interesting thanks! I definitely think this area of the package is pretty useful. IMO: it is a lot easier to read and understand from a code perspective than a large nested dictionary, and if someone is not using the block kit builder it is definitely a lot easier to write the code using the models.

No, you can directly pass an array of model objects as blocks keyword argument.

Thanks, I would have had no idea about this, the doc string of chat_postMessage does not suggest this is possible.

For the above reason, we haven't been promoting the feature.

slack_sdk.models is mentioned in the first few paragraphs of the readme ("easy-to-use builders"), maybe worth adding a note as this might mislead other developers as it has me.

Originally posted by @invokermain in #986 (comment)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions