Skip to content

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

Merged
zimeg merged 3 commits into
mainfrom
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 into
mainfrom
zimeg-docs-oauth-homedir

Conversation

@zimeg

@zimegzimeg commented Oct 2, 2025

Copy link
Copy Markdown
Member

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.

@zimegzimeg added this to the 3.37.0 milestone Oct 2, 2025
@zimegzimeg self-assigned this Oct 2, 2025
@zimegzimeg 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

@zimegzimeg left a comment

Copy link
Copy Markdown
MemberAuthor

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!


rm -rf docs/reference

pdoc slack_sdk --html -o docs/reference

Copy link
Copy Markdown
MemberAuthor

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
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Praise 🙏

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

praise: Very clever!

@zimegzimeg linked an issue Oct 2, 2025 that may be closed by this pull request
@codecov

codecovBot commented Oct 2, 2025

Copy link
Copy Markdown

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.

@WilliamBergaminWilliamBergamin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Clever solution 💯 🚀


rm -rf docs/reference

pdoc slack_sdk --html -o docs/reference

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Praise 🙏

@zimegzimeg modified the milestones: 3.37.0, 3.38.0Oct 7, 2025

@mwbrooksmwbrooks left a comment

Copy link
Copy Markdown
Member

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! 🧠


rm -rf docs/reference

pdoc slack_sdk --html -o docs/reference

Copy link
Copy Markdown
Member

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 mainOctober 16, 2025 00:14
@zimeg
zimegforce-pushed the zimeg-docs-oauth-homedir branch from 1503cb8 to 6337dddCompareOctober 16, 2025 00:20
@zimeg

Copy link
Copy Markdown
MemberAuthor

@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 mainOct 16, 2025
12 checks passed
@zimeg
zimeg deleted the zimeg-docs-oauth-homedir branch October 16, 2025 17:20
@zimegzimeg added this to the 3.38.0 milestone Oct 16, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugM-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documenteddocsM-T: Documentation work onlyoauthsemver:patchVersion: 3x

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove user base dir paths from generated documentation

3 participants

@zimeg@mwbrooks@WilliamBergamin