📝 docs(appauthor): clarify None vs False on Windows#476
Merged
gaborbernat merged 2 commits intotox-dev:mainfrom Apr 6, 2026
Merged
📝 docs(appauthor): clarify None vs False on Windows#476gaborbernat merged 2 commits intotox-dev:mainfrom
gaborbernat merged 2 commits intotox-dev:mainfrom
Conversation
Users were surprised that `user_config_path("myapp")` produces
`AppData/Local/myapp/myapp` on Windows. The `appauthor=None` default
falls back to `appname`, creating a doubled directory. This was
documented only in a brief sentence in the API docstring.
Added clear explanations across all four Diátaxis dimensions so users
discover this behavior regardless of how they read the docs: tutorial
note after the first Windows example, a how-to recipe with all three
variants, expanded explanation in the Windows conventions section, and
explicit `None` example in the parameter reference.
Ref: tox-dev#471
for more information, see https://pre-commit.ci
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Windows users calling
user_config_path("myapp")are surprised to getAppData/Local/myapp/myappinstead ofAppData/Local/myapp. Theappauthorparameter defaults toNone, which falls back toappname, creating a doubled directory structure. This is intentional (following the Windows convention of grouping apps by publisher) but the previous docs only mentioned it in a single sentence buried in theappauthordocstring. 📋 Issue #471 reported this confusion.The fix adds clear explanations across all four Diátaxis dimensions so users discover this behavior regardless of how they read the docs. The tutorial now calls it out right after the first Windows path example. A new how-to recipe shows all three
appauthorvariants side by side. The explanation section spells out the fallback logic in the Windows conventions. The parameter reference adds an explicitNoneexample showing the doubled path. The API docstring also gains a.. note::block.Closes #471