Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ronaldoussoren committed Jul 9, 2024
1 parent 95da637 commit 930ee6d
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions src/py2app/_macho_audit.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
"""
Helpers for auditing the result
of "MachoStandalone" for issues
that might affect portability.
The 'audit_macho_issues' function checks the MachO files in
a bundle for issues that can make the bundle less standalone
than intended:
"""

__all__ = ("audit_macho_issues",)

import os
import pathlib
import typing
Expand Down Expand Up @@ -57,6 +59,15 @@ def audit_macho_issues(
files in the bundle bundle (for example "13.2")
* The ``warnings`` are a list of warnings to be shown to the user.
- Missing or unexpected load commands
- Deployment target mismatch between x86_64 and arm64
- Load commands that refer to files outside of the bundle (except for system locations)
- @rpath/..., @executable_path/... and @loader_path/... that
refer to files that cannot be found.
"""
# XXX: Adjust for py2app's needs:
# - Check if linked to libraries actually exist:
Expand Down

0 comments on commit 930ee6d

Please sign in to comment.