Skip to content

Commit

Permalink
Comment clean-up.
Browse files Browse the repository at this point in the history
  • Loading branch information
calebwherry committed Feb 5, 2024
1 parent dcf07f1 commit cd69921
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions amalgam/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

class _LoadEntityStatus(Structure):
"""
A custom status class from Amalgam LoadEntity.
A private status returned from Amalgam binary LoadEntity C API.
This is implemented with ctypes for accessing binary amalgam builds in
This is implemented with ctypes for accessing binary Amalgam builds in
Linux, MacOS and Windows.
"""
_fields_ = [
Expand All @@ -31,7 +31,10 @@ class _LoadEntityStatus(Structure):

class LoadEntityStatus:
"""
Public status for LoadEntity
Status returned by :func:`~api.Amalgam.load_entity`.
This is implemented with python types and is meant to wrap _LoadEntityStatus
which uses ctypes and directly interacts with the Amalgam binaries.
"""
def __init__(self, c_status: _LoadEntityStatus = None):
if c_status is None:
Expand Down

0 comments on commit cd69921

Please sign in to comment.