fix broken filewrapper funcs

Author: thatstoasty

gojo/builtins/attributes.mojo

@@ -4,8 +4,7 @@ from collections import InlineList
 fn copy[
     T: CollectionElement, is_trivial: Bool
 ](inout target: List[T, is_trivial], source: List[T, is_trivial], start: Int = 0) -> Int:
-    """Copies the contents of source into target at the same index. Returns the number of bytes copied.
-    Added a start parameter to specify the index to start copying into.
+    """Copies the contents of source into target at the same index.
 
     Args:
         target: The buffer to copy into.
@@ -27,91 +26,20 @@ fn copy[
     return count
 
 
-# fn copy[T: CollectionElement](inout target_span: Span[T], source_span: Span[T], start: Int = 0) -> Int:
-#     """Copies the contents of source into target at the same index. Returns the number of bytes copied.
-#     Added a start parameter to specify the index to start copying into.
-
-#     Args:
-#         target_span: The buffer to copy into.
-#         source_span: The buffer to copy from.
-#         start: The index to start copying into.
-
-#     Returns:
-#         The number of bytes copied.
-#     """
-#     var count = 0
-
-#     for i in range(len(source_span)):
-#         target_span[i + start] = source_span[i]
-#         count += 1
-
-#     target_span._len += count
-#     return count
-
-
-# fn copy[T: CollectionElementNew](inout target_span: Span[T], source: InlineList[T], start: Int = 0) -> Int:
-#     """Copies the contents of source into target at the same index. Returns the number of bytes copied.
-#     Added a start parameter to specify the index to start copying into.
-
-#     Args:
-#         target_span: The buffer to copy into.
-#         source: The buffer to copy from.
-#         start: The index to start copying into.
-
-#     Returns:
-#         The number of bytes copied.
-#     """
-#     var count = 0
-
-#     for i in range(len(source)):
-#         target_span[i + start] = source[i]
-#         count += 1
-
-#     target_span._len += count
-#     return count
-
-
-# fn copy[T: CollectionElementNew, T2: CollectionElement](inout list: InlineList[T], source: Span[T2], start: Int = 0) -> Int:
-#     """Copies the contents of source into target at the same index. Returns the number of bytes copied.
-#     Added a start parameter to specify the index to start copying into.
-
-#     Args:
-#         list: The buffer to copy into.
-#         source: The buffer to copy from.
-#         start: The index to start copying into.
-
-#     Returns:
-#         The number of bytes copied.
-#     """
-#     var count = 0
-
-#     for i in range(len(source)):
-#         if i + start > len(list):
-#             list[i + start] = source[i]
-#         else:
-#             list.append(source[i])
-#         count += 1
-
-#     return count
-
-
-fn copy(target: UnsafePointer[UInt8], source: UnsafePointer[UInt8], source_length: Int, start: Int = 0) -> Int:
-    """Copies the contents of source into target at the same index. Returns the number of bytes copied.
-    Added a start parameter to specify the index to start copying into.
+fn copy(target: UnsafePointer[UInt8], source: UnsafePointer[UInt8], source_length: Int) -> Int:
+    """Copies the contents of source into target at the same index.
 
     Args:
         target: The buffer to copy into.
         source: The buffer to copy from.
         source_length: The length of the source buffer.
-        start: The index to start copying into.
 
     Returns:
         The number of bytes copied.
     """
     var count = 0
-
     for i in range(source_length):
-        target[i + start] = source[i]
+        target[i] = source[i]
         count += 1
 
     return count
@@ -124,8 +52,7 @@ fn copy(
     source_end: Int,
     target_start: Int = 0,
 ) -> Int:
-    """Copies the contents of source into target at the same index. Returns the number of bytes copied.
-    Added a start parameter to specify the index to start copying into.
+    """Copies the contents of source into target at the same index.
 
     Args:
         target: The buffer to copy into.

gojo/builtins/bytes.mojo

@@ -4,6 +4,12 @@ alias Byte = UInt8
 
 
 fn equals[is_trivial: Bool](left: List[UInt8, is_trivial], right: List[UInt8, is_trivial]) -> Bool:
+    """Reports if `left` and `right` are equal.
+
+    Args:
+        left: The first list to compare.
+        right: The second list to compare.
+    """
     if len(left) != len(right):
         return False
     for i in range(len(left)):
@@ -13,44 +19,38 @@ fn equals[is_trivial: Bool](left: List[UInt8, is_trivial], right: List[UInt8, is
 
 
 fn has_prefix[is_trivial: Bool](bytes: List[Byte, is_trivial], prefix: List[Byte, is_trivial]) -> Bool:
-    """Reports whether the List[Byte] struct begins with prefix.
+    """Reports if the list begins with prefix.
 
     Args:
-        bytes: The List[Byte] struct to search.
+        bytes: The list to search.
         prefix: The prefix to search for.
-
-    Returns:
-        True if the List[Byte] struct begins with prefix; otherwise, False.
     """
     var len_comparison = len(bytes) >= len(prefix)
     var prefix_comparison = equals(bytes[0 : len(prefix)], prefix)
     return len_comparison and prefix_comparison
 
 
 fn has_suffix[is_trivial: Bool](bytes: List[Byte, is_trivial], suffix: List[Byte, is_trivial]) -> Bool:
-    """Reports whether the List[Byte] struct ends with suffix.
+    """Reports if the list ends with suffix.
 
     Args:
-        bytes: The List[Byte] struct to search.
-        suffix: The prefix to search for.
-
-    Returns:
-        True if the List[Byte] struct ends with suffix; otherwise, False.
+        bytes: The list struct to search.
+        suffix: The suffix to search for.
     """
     var len_comparison = len(bytes) >= len(suffix)
     var suffix_comparison = equals(bytes[len(bytes) - len(suffix) : len(bytes)], suffix)
     return len_comparison and suffix_comparison
 
 
 fn index_byte[is_trivial: Bool](bytes: List[Byte, is_trivial], delim: Byte) -> Int:
-    """Return the index of the first occurrence of the byte delim.
+    """Return the index of the first occurrence of the byte `delim`.
 
     Args:
-        bytes: The List[Byte] struct to search.
+        bytes: The list to search.
         delim: The byte to search for.
 
     Returns:
-        The index of the first occurrence of the byte delim.
+        The index of the first occurrence of the byte `delim`.
     """
     for i in range(len(bytes)):
         if bytes[i] == delim:
@@ -60,15 +60,15 @@ fn index_byte[is_trivial: Bool](bytes: List[Byte, is_trivial], delim: Byte) -> I
 
 
 fn index_byte(bytes: UnsafePointer[Scalar[DType.uint8]], size: Int, delim: Byte) -> Int:
-    """Return the index of the first occurrence of the byte delim.
+    """Return the index of the first occurrence of the byte `delim`.
 
     Args:
-        bytes: The DTypePointer[DType.int8] struct to search.
-        size: The size of the bytes pointer.
+        bytes: The list to search.
+        size: The number of elements stored at the pointer address.
         delim: The byte to search for.
 
     Returns:
-        The index of the first occurrence of the byte delim.
+        The index of the first occurrence of the byte `delim`.
     """
     for i in range(size):
         if UInt8(bytes[i]) == delim:
@@ -78,14 +78,14 @@ fn index_byte(bytes: UnsafePointer[Scalar[DType.uint8]], size: Int, delim: Byte)
 
 
 fn index_byte(bytes: Span[UInt8], delim: Byte) -> Int:
-    """Return the index of the first occurrence of the byte delim.
+    """Return the index of the first occurrence of the byte `delim`.
 
     Args:
         bytes: The Span to search.
         delim: The byte to search for.
 
     Returns:
-        The index of the first occurrence of the byte delim.
+        The index of the first occurrence of the byte `delim`.
     """
     for i in range(len(bytes)):
         if bytes[i] == delim:
@@ -95,13 +95,14 @@ fn index_byte(bytes: Span[UInt8], delim: Byte) -> Int:
 
 
 fn to_string[is_trivial: Bool](bytes: List[Byte, is_trivial]) -> String:
-    """Makes a deepcopy of the List[Byte] supplied and converts it to a string. If it's not null terminated, it will append a null byte.
+    """Makes a deep copy of the list supplied and converts it to a string.
+    If it's not null terminated, it will append a null byte.
 
     Args:
-        bytes: The List[Byte] struct to convert.
+        bytes: The list to convert.
 
     Returns:
-        The string representation of the List[Byte] struct.
+        A String built from the list of bytes.
     """
     var copy = List[Byte](bytes)
     if copy[-1] != 0:

gojo/builtins/errors.mojo

@@ -1,7 +1,7 @@
 from sys import exit
 
 
-fn panic[T: Stringable](message: T, code: Int = 1):
+fn panic[T: Stringable](message: T, code: Int = 1) -> None:
     """Panics the program with the given message and exit code.
 
     Args:

gojo/bytes/buffer.mojo

@@ -194,7 +194,7 @@ struct Buffer(
         """
         return self.as_string_slice()
 
-    @deprecated("Buffer.render() has been deprecated. Use Buffer.as_string_slice() instead.")
+    @deprecated("Buffer.render() has been deprecated. Use Buffer.as_string_slice() or call str() instead.")
     fn render(self) -> StringSlice[__lifetime_of(self)]:
         """
         Return a StringSlice view of the data owned by the builder.

gojo/fmt/fmt.mojo

@@ -75,6 +75,15 @@ fn find_first_verb(s: String, verbs: List[String]) -> String:
 
 
 fn format_string(format: String, arg: String) -> String:
+    """Format a string argument.
+
+    Args:
+        format: The format string.
+        arg: The string argument.
+
+    Returns:
+        The formatted string.
+    """
     var verb = find_first_verb(format, List[String]("%s", "%q"))
     var arg_to_place = arg
     if verb == "%q":
@@ -84,6 +93,15 @@ fn format_string(format: String, arg: String) -> String:
 
 
 fn format_bytes(format: String, arg: List[UInt8, True]) -> String:
+    """Format a byte list argument.
+
+    Args:
+        format: The format string.
+        arg: The byte list argument.
+
+    Returns:
+        The formatted byte list.
+    """
     var argument = arg
     if argument[-1] != 0:
         argument.append(0)
@@ -92,6 +110,15 @@ fn format_bytes(format: String, arg: List[UInt8, True]) -> String:
 
 
 fn format_integer(format: String, arg: Int) -> String:
+    """Format an integer argument.
+
+    Args:
+        format: The format string.
+        arg: The integer argument.
+
+    Returns:
+        The formatted integer.
+    """
     var verb = find_first_verb(format, List[String]("%d", "%q"))
     var arg_to_place = str(arg)
     if verb == "%q":
@@ -101,28 +128,55 @@ fn format_integer(format: String, arg: Int) -> String:
 
 
 fn format_float(format: String, arg: Float64) -> String:
+    """Format a float argument.
+
+    Args:
+        format: The format string.
+        arg: The float argument.
+
+    Returns:
+        The formatted float.
+    """
     return replace_first(format, str("%f"), str(arg))
 
 
 fn format_boolean(format: String, arg: Bool) -> String:
+    """Format a boolean argument.
+
+    Args:
+        format: The format string.
+        arg: The boolean argument.
+
+    Returns:
+        The formatted boolean.
+    """
     var value: String = "False"
     if arg:
         value = "True"
 
     return replace_first(format, String("%t"), value)
 
 
-# If the number of arguments does not match the number of format specifiers
-alias BadArgCount = "(BAD ARG COUNT)"
+alias BAD_ARG_COUNT = "(BAD ARG COUNT)"
+"""If the number of arguments does not match the number of format specifiers."""
 
 
 fn sprintf(formatting: String, *args: Args) -> String:
+    """Format a string with the given arguments.
+
+    Args:
+        formatting: The format string.
+        args: The arguments to format the string with.
+
+    Returns:
+        The formatted string.
+    """
     var text = formatting
     var raw_percent_count = formatting.count("%%") * 2
     var formatter_count = formatting.count("%") - raw_percent_count
 
     if formatter_count != len(args):
-        return BadArgCount
+        return BAD_ARG_COUNT
 
     for i in range(len(args)):
         var argument = args[i]
@@ -142,6 +196,15 @@ fn sprintf(formatting: String, *args: Args) -> String:
 
 # TODO: temporary until we have arg packing.
 fn sprintf_str(formatting: String, args: List[String]) raises -> String:
+    """Format a string with the given arguments.
+
+    Args:
+        formatting: The format string.
+        args: The arguments to format the string with.
+
+    Returns:
+        The formatted string.
+    """
     var text = formatting
     var formatter_count = formatting.count("%")
 
@@ -157,6 +220,12 @@ fn sprintf_str(formatting: String, args: List[String]) raises -> String:
 
 
 fn printf(formatting: String, *args: Args) raises:
+    """Print a formatted string with the given arguments.
+
+    Args:
+        formatting: The format string.
+        args: The arguments to format the string with.
+    """
     var text = formatting
     var raw_percent_count = formatting.count("%%") * 2
     var formatter_count = formatting.count("%") - raw_percent_count