Skip to content

Fix #1160 Links in README don't render properly on PyPi project page#1163

Merged
seratch merged 1 commit intoslackapi:mainfrom
seratch:issue-1160-readme
Jan 21, 2022
Merged

Fix #1160 Links in README don't render properly on PyPi project page#1163
seratch merged 1 commit intoslackapi:mainfrom
seratch:issue-1160-readme

Conversation

@seratch
Copy link
Copy Markdown
Contributor

@seratch seratch commented Jan 21, 2022

Summary

This pull request resolves #1160. You can check the current state here: https://pypi.org/project/slack-sdk/ ("Getting started tutorial" section)

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.

@seratch seratch added bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented docs M-T: Documentation work only Version: 3x labels Jan 21, 2022
@seratch seratch added this to the 3.14.0 milestone Jan 21, 2022
@seratch seratch requested review from filmaj and misscoded January 21, 2022 03:48
@seratch seratch self-assigned this Jan 21, 2022
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 21, 2022

Codecov Report

Merging #1163 (d539030) into main (afa40ea) will decrease coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1163      +/-   ##
==========================================
- Coverage   86.62%   86.57%   -0.05%     
==========================================
  Files         110      110              
  Lines       10774    10774              
==========================================
- Hits         9333     9328       -5     
- Misses       1441     1446       +5
Impacted Files Coverage Δ
slack_sdk/socket_mode/builtin/internals.py 70.22% <0.00%> (-2.23%) ⬇️

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 afa40ea...d539030. Read the comment docs.

filmaj
filmaj approved these changes Jan 21, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@filmaj filmaj left a comment

Choose a reason for hiding this comment

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

Looks good. The table of contents links are still broken but I am not sure how we can fix that, as the pypi-generated page based off the readme does not include any anchor IDs or other ways that we can programmatically jump to heading sections of the page 😞

@seratch
Copy link
Copy Markdown
Contributor Author

seratch commented Jan 21, 2022

The table of contents links are still broken but I am not sure how we can fix that,

Yes, I also noticed this but we can fix it once we find a good way to go.

Thanks for the review!

@seratch seratch merged commit 1a1865a into slackapi:main Jan 21, 2022
@seratch seratch deleted the issue-1160-readme branch January 21, 2022 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@misscoded misscoded Awaiting requested review from misscoded

1 more reviewer

@filmaj filmaj filmaj approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@seratch seratch

Labels

bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented docs M-T: Documentation work only Version: 3x

Projects

None yet

Milestone

3.14.0

Development

Successfully merging this pull request may close these issues.

Links in README don't render properly on PyPi project page

2 participants

@seratch @filmaj