From e16abc56bed7b23200eb7596d7ee5e958d35d756 Mon Sep 17 00:00:00 2001 From: ajpotts Date: Thu, 5 Mar 2026 12:48:26 -0500 Subject: [PATCH] Closes #5458: client_dtypes docstring rendering poorly --- arkouda/client_dtypes.py | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/arkouda/client_dtypes.py b/arkouda/client_dtypes.py index dbd880f2570..6a53e72190e 100644 --- a/arkouda/client_dtypes.py +++ b/arkouda/client_dtypes.py @@ -9,14 +9,22 @@ - `IPv4`: For storing and displaying 32-bit integers as IPv4 addresses. These classes enhance usability and improve readability when working with encoded or -domain-specific data while preserving Arkouda’s performance model and distributed data structures. +domain-specific data while preserving Arkouda's performance model and distributed data +structures. Functions --------- -- `bit_vectorizer`: Creates a partially applied BitVector constructor. -- `ip_address`: Converts various formats to an Arkouda IPv4 object. -- `is_ipv4`: Returns a boolean array indicating IPv4 addresses. -- `is_ipv6`: Returns a boolean array indicating IPv6 addresses. +bit_vectorizer + Creates a partially applied BitVector constructor. + +ip_address + Converts various formats to an Arkouda IPv4 object. + +is_ipv4 + Returns a boolean array indicating IPv4 addresses. + +is_ipv6 + Returns a boolean array indicating IPv6 addresses. Examples -------- @@ -24,6 +32,7 @@ >>> from arkouda.client_dtypes import BitVector, Fields, IPv4, ip_address, is_ipv4 Create and use BitVectors: + >>> a = ak.array([3, 5, 7]) >>> bv = BitVector(a, width=4) >>> print(bv) @@ -33,11 +42,13 @@ width=4, reverse=False) Create Fields with named binary flags: + >>> f = Fields(ak.array([1, 2, 3]), names=['read', 'write', 'exec'], separator=':') >>> print(f[0]) # doctest: +SKIP --:--:read (1) Convert and work with IP addresses: + >>> ips = ip_address(['192.168.0.1', '10.0.0.1']) >>> print(ips) IPv4([192.168.0.1, @@ -46,7 +57,6 @@ >>> is_ipv4(ips) array([True True]) - """ from functools import partial