chore(release): 1.0.0

Ravencentric · Jul 30, 2024 · 2717295 · 2717295
1 parent bb76f9b
commit 2717295
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "archivefile"
-version = "0.4.0"
+version = "1.0.0"
 description = "Unified interface for tar, zip, sevenzip, and rar files"
 authors = ["Ravencentric <[email protected]>"]
 readme = "README.md"

diff --git a/src/archivefile/_adapters/_base.py b/src/archivefile/_adapters/_base.py
@@ -22,6 +22,10 @@
 
 
 class BaseArchiveAdapter(Protocol):
+    """
+    A base protocol that can be inherited from to implement more adapters.
+    Refer to `src/archivefile/_core.py` for documentation of every method and property.
+    """
     # fmt: off
     @overload
     def __init__(self, file: StrPath, mode: OpenArchiveMode = "r", *, password: str | None = None, compression_type: CompressionType | None = None, compression_level: CompressionLevel | None = None, **kwargs: Any) -> None: ...

diff --git a/src/archivefile/_core.py b/src/archivefile/_core.py
@@ -66,7 +66,7 @@ def __init__(
         file : StrPath
             Path to the archive file.
         mode : OpenArchiveMode, optional
-            Specifies the mode for opening the archive file.
+            Mode for opening the archive file.
         password : str, optional
             Password for encrypted archive files.
         compression_type : CompressionType, optional