docs(oauth): use a variable "base_dir" home path for file stores #1760
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zimeg
requested review from
WilliamBergamin,
lukegalbraithrussell,
mwbrooks and
srtaalej
zimeg
added
bug
zimeg
commented
Oct 2, 2025
|
|
||
| rm -rf docs/reference | ||
|
|
||
| pdoc slack_sdk --html -o docs/reference |
There was a problem hiding this comment.
🗣️ 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.
Codecov Report✅ All modified and coverable lines are covered by tests. 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. |
WilliamBergamin
approved these changes
Oct 2, 2025
|
|
||
| rm -rf docs/reference | ||
|
|
||
| pdoc slack_sdk --html -o docs/reference |
mwbrooks
approved these changes
Oct 14, 2025
|
|
||
| rm -rf docs/reference | ||
|
|
||
| pdoc slack_sdk --html -o docs/reference |
zimeg
force-pushed
the
zimeg-docs-oauth-homedir
branch
from
1503cb8 to
6337ddd
Compare
|
@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 📚 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR replaces the
base_dirdefault 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
Category
/docs(Documents)Requirements
python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.