Skip to content

Commit b28743a

Browse files
committed
Change .open docs
1 parent f08bed0 commit b28743a

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

tivars/var.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -211,9 +211,10 @@ def load_from_file(self, file: BinaryIO):
211211
@classmethod
212212
def open(cls, filename: str) -> 'TIHeader':
213213
"""
214-
Loads this header from a file given a filename
214+
Creates a new header from a file given a filename
215215
216216
:param filename: A filename to open
217+
:return: The header stored in the file
217218
"""
218219

219220
with open(filename, 'rb') as file:
@@ -788,9 +789,10 @@ def string(self) -> str:
788789
@classmethod
789790
def open(cls, filename: str) -> 'TIEntry':
790791
"""
791-
Loads this entry from a file given a filename
792+
Creates a new entry from a file given a filename
792793
793794
:param filename: A filename to open
795+
:return: The (first) entry stored in the file
794796
"""
795797

796798
if cls._type_id is not None and \
@@ -1125,9 +1127,10 @@ def load_var_file(self, file: BinaryIO):
11251127
@classmethod
11261128
def open(cls, filename: str) -> 'TIVar':
11271129
"""
1128-
Loads this var from a file given a filename
1130+
Creates a new var from a file given a filename
11291131
11301132
:param filename: A filename to open
1133+
:return: The var stored in the file
11311134
"""
11321135

11331136
with open(filename, 'rb') as file:

0 commit comments

Comments
 (0)