Skip to content

docs(oauth): use a variable "base_dir" home path for file stores#1760

Merged
zimeg merged 3 commits intomainfrom
zimeg-docs-oauth-homedir
Oct 16, 2025
Merged

docs(oauth): use a variable "base_dir" home path for file stores#1760
zimeg merged 3 commits intomainfrom
zimeg-docs-oauth-homedir

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Oct 2, 2025

Summary

This PR replaces the base_dir default shown in documentation to use the "$HOME" placeholder instead of a particular path. Fixes #1752.

Testing

No changes to functionalities! The docs I hope are more clear with this change too 📚

Notes

  • Super open to other suggestions instead of "$HOME"!

Category

  • /docs (Documents)

Requirements

  • 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.

@zimeg zimeg added this to the 3.37.0 milestone Oct 2, 2025
@zimeg zimeg self-assigned this Oct 2, 2025
@zimeg zimeg added bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented docs M-T: Documentation work only semver:patch Version: 3x oauth labels Oct 2, 2025
zimeg
zimeg commented Oct 2, 2025
View reviewed changes
Copy link
Member Author

@zimeg zimeg left a comment

Choose a reason for hiding this comment

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

📬 A note on change for reviewers!

scripts/generate_api_docs.sh

rm -rf docs/reference

pdoc slack_sdk --html -o docs/reference
Copy link
Member Author

@zimeg zimeg Oct 2, 2025

Choose a reason for hiding this comment

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

🗣️ note: This change keeps this script consistent going forward! As far as I can tell, overriding the HOME variable causes no problem for pdoc or reference.

Copy link
Contributor

@WilliamBergamin WilliamBergamin Oct 2, 2025

Choose a reason for hiding this comment

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

Praise 🙏

Copy link
Member

@mwbrooks mwbrooks Oct 14, 2025

Choose a reason for hiding this comment

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

praise: Very clever!

@zimeg zimeg linked an issue Oct 2, 2025 that may be closed by this pull request
Remove user base dir paths from generated documentation #1752
Closed
@codecov
Copy link

codecov bot commented Oct 2, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.15%. Comparing base (577d6b4) to head (d15f94b).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1760   +/-   ##
=======================================
  Coverage   85.15%   85.15%           
=======================================
  Files         115      115           
  Lines       13068    13068           
=======================================
  Hits        11128    11128           
  Misses       1940     1940

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

WilliamBergamin
WilliamBergamin approved these changes Oct 2, 2025
View reviewed changes
Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

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

Clever solution 💯 🚀

scripts/generate_api_docs.sh

rm -rf docs/reference

pdoc slack_sdk --html -o docs/reference
Copy link
Contributor

@WilliamBergamin WilliamBergamin Oct 2, 2025

Choose a reason for hiding this comment

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

Praise 🙏

@zimeg zimeg modified the milestones: 3.37.0, 3.38.0 Oct 7, 2025
mwbrooks
mwbrooks approved these changes Oct 14, 2025
View reviewed changes
Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

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

✅ Great solution @zimeg! I did a little digging and didn't find a configuration option, so you're solution was a great alternative! 🧠

scripts/generate_api_docs.sh

rm -rf docs/reference

pdoc slack_sdk --html -o docs/reference
Copy link
Member

@mwbrooks mwbrooks Oct 14, 2025

Choose a reason for hiding this comment

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

praise: Very clever!

@zimeg zimeg changed the base branch from zimeg-ci-docgen to main October 16, 2025 00:14
@zimeg zimeg force-pushed the zimeg-docs-oauth-homedir branch from 1503cb8 to 6337ddd Compare October 16, 2025 00:20
@zimeg
Copy link
Member Author

zimeg commented Oct 16, 2025

@WilliamBergamin @mwbrooks Thanks both for the kind reviews! 👾 ✨

I had to change the base branch after rushing to put this PR up, but the same changes remains so I will merge this now 📚

@zimeg zimeg merged commit 344e0c5 into main Oct 16, 2025
12 checks passed
@zimeg zimeg deleted the zimeg-docs-oauth-homedir branch October 16, 2025 17:20
@zimeg zimeg added this to the 3.38.0 milestone Oct 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mwbrooks mwbrooks mwbrooks approved these changes

@WilliamBergamin WilliamBergamin WilliamBergamin approved these changes

@lukegalbraithrussell lukegalbraithrussell Awaiting requested review from lukegalbraithrussell

@srtaalej srtaalej Awaiting requested review from srtaalej

Assignees

@zimeg zimeg

Labels

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

Projects

None yet

Milestone

3.38.0

Development

Successfully merging this pull request may close these issues.

Remove user base dir paths from generated documentation

3 participants

@zimeg @mwbrooks @WilliamBergamin