Skip to content

Commit 843b49e

Browse files
appdirs: improve annotation for appauthor argument (#9876)
Fix: Missing annotation for appauthor argument According to the appdirs doc string and code [1], the appauthor argument in all functions supports False as argument value to skip insertion of author directories. [1] https://github.com/ActiveState/appdirs/blob/master/appdirs.py#L52
1 parent 978d885 commit 843b49e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

stubs/appdirs/appdirs.pyi

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@ unicode = str
66
system: str
77

88
def user_data_dir(
9-
appname: str | None = ..., appauthor: str | None = ..., version: str | None = ..., roaming: bool = ...
9+
appname: str | None = ..., appauthor: str | Literal[False] | None = ..., version: str | None = ..., roaming: bool = ...
1010
) -> str: ...
1111
def site_data_dir(
12-
appname: str | None = ..., appauthor: str | None = ..., version: str | None = ..., multipath: bool = ...
12+
appname: str | None = ..., appauthor: str | Literal[False] | None = ..., version: str | None = ..., multipath: bool = ...
1313
) -> str: ...
1414
def user_config_dir(
15-
appname: str | None = ..., appauthor: str | None = ..., version: str | None = ..., roaming: bool = ...
15+
appname: str | None = ..., appauthor: str | Literal[False] | None = ..., version: str | None = ..., roaming: bool = ...
1616
) -> str: ...
1717
def site_config_dir(
18-
appname: str | None = ..., appauthor: str | None = ..., version: str | None = ..., multipath: bool = ...
18+
appname: str | None = ..., appauthor: str | Literal[False] | None = ..., version: str | None = ..., multipath: bool = ...
1919
) -> str: ...
2020
def user_cache_dir(
21-
appname: str | None = ..., appauthor: str | None = ..., version: str | None = ..., opinion: bool = ...
21+
appname: str | None = ..., appauthor: str | Literal[False] | None = ..., version: str | None = ..., opinion: bool = ...
2222
) -> str: ...
2323
def user_state_dir(
24-
appname: str | None = ..., appauthor: str | None = ..., version: str | None = ..., roaming: bool = ...
24+
appname: str | None = ..., appauthor: str | Literal[False] | None = ..., version: str | None = ..., roaming: bool = ...
2525
) -> str: ...
2626
def user_log_dir(
27-
appname: str | None = ..., appauthor: str | None = ..., version: str | None = ..., opinion: bool = ...
27+
appname: str | None = ..., appauthor: str | Literal[False] | None = ..., version: str | None = ..., opinion: bool = ...
2828
) -> str: ...
2929

3030
class AppDirs:
@@ -36,7 +36,7 @@ class AppDirs:
3636
def __init__(
3737
self,
3838
appname: str | None = ...,
39-
appauthor: str | None = ...,
39+
appauthor: str | Literal[False] | None = ...,
4040
version: str | None = ...,
4141
roaming: bool = ...,
4242
multipath: bool = ...,

0 commit comments

Comments
 (0)