Skip to content

Commit 9520cd9

Browse files
authored
Docs: platformdirs is a package (#88)
1 parent caacbed commit 9520cd9

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

README.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ On Linux (and other Unices), according to the `XDG Basedir Spec`_, it should be:
3131
``platformdirs`` to the rescue
3232
==============================
3333

34-
This kind of thing is what the ``platformdirs`` module is for.
34+
This kind of thing is what the ``platformdirs`` package is for.
3535
``platformdirs`` will help you choose an appropriate:
3636

3737
- user data dir (``user_data_dir``)
@@ -45,7 +45,6 @@ This kind of thing is what the ``platformdirs`` module is for.
4545

4646
And also:
4747

48-
- Is a single module so other Python packages can vendor their own private copy.
4948
- Is slightly opinionated on the directory names used. Look for "OPINION" in
5049
documentation and code for when an opinion is being applied.
5150

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ requires = ["hatchling>=0.22.0", "hatch-vcs"]
44

55
[project]
66
name = "platformdirs"
7-
description = 'A small Python module for determining appropriate platform-specific dirs, e.g. a "user data dir".'
7+
description = 'A small Python package for determining appropriate platform-specific dirs, e.g. a "user data dir".'
88
readme = "README.rst"
99
license = "MIT"
1010
maintainers = [

0 commit comments

Comments
 (0)