Skip to content

Commit

Permalink
Doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Erotemic committed Nov 4, 2023
1 parent 360f015 commit bbe43d8
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion ubelt/util_format.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
This module is deprecated. Use util_repr instead.
This module is deprecated. Use :mod:`ubelt.util_repr` instead.
"""
from .util_repr import urepr, ReprExtensions, _REPR_EXTENSIONS

Expand Down
10 changes: 5 additions & 5 deletions ubelt/util_hash.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
r"""
Wrappers around hashlib functions to generate hash signatures for common data.
The hashes are deterministic across python versions and operating systems.
This is verified by CI testing on Windows, Linux, Python with 2.7, 3.4, and
greater, and on 32 and 64 bit versions.
The hashes are deterministic across Python versions and operating systems.
This is verified by CI testing on 32 and 64 bit versions of Windows, Linux, and
OSX with all supported Python.
Use Case #1: You have data that you want to hash. If we assume the data is in
standard python scalars or ordered sequences: e.g. tuple, list, odict, oset,
int, str, etc..., then the solution is :func:`hash_data`.
standard python scalars or ordered sequences: e.g. tuple, list, OrderedDict,
OrderedSet, int, str, etc..., then the solution is :func:`hash_data`.
Use Case #2: You have a file you want to hash, but your system doesn't have a
sha1sum executable (or you dont want to use Popen). The solution is
Expand Down
9 changes: 5 additions & 4 deletions ubelt/util_str.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
"""
Functions for working with text and strings.
The :func:`ensure_unicode` function does its best to coerce Python 2/3 bytes
and text into a consistent unicode text representation.
The :func:`codeblock` and :func:`paragraph` wrap multiline strings to help
write text blocks without hindering the surrounding code indentation.
Expand Down Expand Up @@ -181,7 +178,11 @@ def hzcat(args, sep=''):

def ensure_unicode(text):
r"""
Casts bytes into utf8 (mostly for python2 compatibility)
Casts bytes into utf8 (mostly for python2 compatibility).
Note:
This function is deprecated and will no longer be available in version
2.0.0.
Args:
text (str | bytes):
Expand Down

0 comments on commit bbe43d8

Please sign in to comment.