frigid 2.0__tar.gz → 2.0rc0__tar.gz

{frigid-2.0 → frigid-2.0rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frigid
-Version: 2.0
+Version: 2.0rc0
 Summary: Immutable data structures.
 Project-URL: Homepage, https://github.com/emcd/python-frigid
 Project-URL: Documentation, https://emcd.github.io/python-frigid

{frigid-2.0 → frigid-2.0rc0}/sources/frigid/__init__.py

@@ -43,7 +43,7 @@ from .objects import *
 from .sequences import *
 
 
-__version__ = '2.0'
+__version__ = '2.0rc0'
 
 
 _attribute_visibility_includes_ = frozenset( ( '__version__', ) )

{frigid-2.0 → frigid-2.0rc0}/sources/frigid/installers.py

@@ -33,7 +33,17 @@ def install(
             'Name to use for single function in builtins. ``None`` to skip.' )
     ] = 'one',
 ) -> None:
-    ''' Installs 1-element tuple constructor into builtins. '''
+    ''' Installs 1-element tuple constructor into builtins.
+
+        Example
+        -------
+        >>> install( )  # Installs as 'one'
+        >>> one( 42 )   # Now available in builtins
+        (42,)
+        >>> install( single_name = 'single' )  # Install with custom name
+        >>> single( 42 )
+        (42,)
+    '''
     builtins = __import__( 'builtins' )
     if single_name:
         from .sequences import one

{frigid-2.0 → frigid-2.0rc0}/sources/frigid/sequences.py

@@ -39,5 +39,13 @@ def one( value: _V ) -> tuple[ _V, ... ]:
 
         * List comprehensions and generator expressions
         * Situations where formatter behavior with trailing commas is undesired
+
+        Example
+        -------
+        >>> one( 42 )
+        (42,)
+        >>> result = [ one( x ) for x in range( 3 ) ]
+        >>> result
+        [(0,), (1,), (2,)]
     '''
     return value, # pylint: disable=trailing-comma-tuple