Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: tox-dev/platformdirs
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 4.9.0
Choose a base ref
...
head repository: tox-dev/platformdirs
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 4.9.1
Choose a head ref
  • 2 commits
  • 10 files changed
  • 3 contributors

Commits on Feb 14, 2026

  1. 📝 docs: enhance README, fix issues, and reorganize platforms.rst (#445) 

    PyPI users need MVP documentation directly in the README without
visiting the full docs. The previous README showed only a few
directories without explaining their purpose. After PR #441 reorganized
documentation into tutorial/how-to/reference pages, several issues
remained: the README still referenced the old structure, api.rst was
missing documentation for new properties, platforms.rst had a mixed
organization that didn't match api.rst, and various cross-references
were broken.

This comprehensive update enhances the README with all directory types
(data, config, cache, state, log, runtime, documents, downloads) and
Path examples. A new Directory types section explains purpose and
`user_*` vs `site_*` variants. 📖 The fork attribution is simplified to
one line since appdirs has been deprecated since 2023.

The api.rst now documents previously missing `user_applications_dir` and
`user_bin_dir` properties with unified headlines using "User X
directory" format. The platforms.rst is reorganized to match api.rst
structure with all user directories grouped together and all site
directories grouped together in the same order as api.rst. ✨
Bi-directional cross-references connect api.rst and platforms.rst
sections so users can easily navigate between API reference and
platform-specific paths.

Additional fixes resolve XDG documentation redundancy through
cross-references, remove non-existent PLATFORMDIRS_* environment
variable mentions, and ensure all documentation builds without warnings.

Addresses #444

---------

Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
    @gaborbernat @pre-commit-ci
    gaborbernat and pre-commit-ci[bot] authored Feb 14, 2026
    Configuration menu
    Copy the full SHA
    d983fb1 View commit details
    Browse the repository at this point in the history

  2. Release 4.9.1

    @gaborbernat
    gaborbernat committed Feb 14, 2026
    Configuration menu
    Copy the full SHA
    f656849 View commit details
    Browse the repository at this point in the history
Loading