Skip to content

📝 docs(usage): note that home dir is in stdlib #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gaborbernat merged 1 commit into from
Feb 14, 2026
+12 −0
Merged

📝 docs(usage): note that home dir is in stdlib #431

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,18 @@ Defaults to ``False``.
dirs = PlatformDirs("SuperApp", "Acme", ensure_exists=True)
dirs.user_cache_dir # directory is created if it does not exist

Directories not covered
-----------------------

``platformdirs`` does not provide a property for the user's **home directory**. Use
:meth:`pathlib.Path.home` or :func:`os.path.expanduser` from the standard library instead:

.. code-block:: pycon

>>> from pathlib import Path
>>> Path.home()
PosixPath('/Users/trentm')

XDG environment variables
-------------------------

Expand Down