Skip to content

Add more docstrings to slack_sdk.models classes #1127

@seratch

Description

@seratch

We've received great feedback on the slack_sdk.models classes from the PyCon JP community 🙌

The slack_sdk.models classes are greatly useful for programmatically building Block Kit UI data in Python. However, there is room for improvement in those classes' docstrings. The docstrings do not provide sufficient information as of today. This makes app development using the classes a bit hard. Particularly, there may be a challenge if a developer is not sure about the required fields and so on.

To improve this, the model classes' docstrings can more detailed information that can be helpful for developers.

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.models (UI component builders)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.rtm (RTM client)
  • slack_sdk.signature (Request Signature Verifier)

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions