Skip to content

Update documentation via doc generation scripts#1220

Merged
seratch merged 1 commit intoslackapi:mainfrom
misscoded:update-generate-docs
May 26, 2022
Merged

Update documentation via doc generation scripts#1220
seratch merged 1 commit intoslackapi:mainfrom
misscoded:update-generate-docs

Conversation

@misscoded
Copy link
Copy Markdown
Contributor

@misscoded misscoded commented May 26, 2022

Summary

PR with updates from running ./scripts/docs.sh and ./scripts/docs-v2.sh.

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.socket_mode (Socket Mode client)
  • slack_sdk.signature (Request Signature Verifier)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.models (UI component builders)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.rtm_v2 (RTM client)
  • /docs-src (Documents, have you run ./scripts/docs.sh?)
  • /docs-src-v2 (Documents, have you run ./scripts/docs-v2.sh?)
  • /tutorial (PythOnBoardingBot tutorial)
  • tests/integration_tests (Automated tests for this library)

Requirements (place an x in each [ ])

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

@misscoded misscoded added the docs M-T: Documentation work only label May 26, 2022
@misscoded misscoded requested a review from seratch May 26, 2022 10:45
@misscoded misscoded self-assigned this May 26, 2022
@misscoded
Copy link
Copy Markdown
Contributor Author

misscoded commented May 26, 2022

@seratch Despite running both commands, the updates made in the last PR haven't been propagated to the following documentation:

  • /docs/api-docs/slack_sdk/models/blocks/block_elements.html
  • /docs/api-docs/slack_sdk/models/blocks/index.html

Am I missing a generation command that should be run, or do these need to be updated by hand?

@seratch
Copy link
Copy Markdown
Contributor

seratch commented May 26, 2022

@misscoded The changes look fine but can you share the reason why you did this now?

@misscoded
Copy link
Copy Markdown
Contributor Author

misscoded commented May 26, 2022

@seratch In the last PR I opened, in response to my offering to push up the documentation changes that surfaced that you see here, you indicated that "more fixes would be appreciated" with a thumbs up. I took that to mean you wanted those changes in.

Did I misunderstand your meaning?

@codecov
Copy link
Copy Markdown

codecov bot commented May 26, 2022

Codecov Report

Merging #1220 (8e3a9ae) into main (830b517) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1220   +/-   ##
=======================================
  Coverage   86.58%   86.59%           
=======================================
  Files         111      111           
  Lines       10943    10943           
=======================================
+ Hits         9475     9476    +1     
+ Misses       1468     1467    -1
Impacted Files Coverage Δ
slack_sdk/socket_mode/builtin/internals.py 72.80% <0.00%> (+0.43%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 830b517...8e3a9ae. Read the comment docs.

@seratch
Copy link
Copy Markdown
Contributor

seratch commented May 26, 2022

@misscoded Sorry! I quickly checked your message early in the morning and totally misread your message in the PR. Somehow, I assumed that you checked the latest API docs in api.slack.com and found more changes in the validation rules in the classes under the models package. But it'd be fine to merge this PR as it's safe.

seratch
seratch approved these changes May 26, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@seratch seratch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No visible changes, but it'd be good to use the latest generator.

@seratch seratch merged commit 4458b2c into slackapi:main May 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@seratch seratch seratch approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@misscoded misscoded

Labels

docs M-T: Documentation work only

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@misscoded @seratch