# THE PUBLIC SURFACE, WRITTEN DOWN SO THAT REMOVING ANY OF IT IS VISIBLE.
#
# Generated by `test_the_public_surface_matches_what_is_written_down`, which also enforces it.
# Regenerate with:  python ci.py surface
#
# WHY THIS FILE EXISTS. A downstream user upgraded runprov and it broke. They surveyed the
# history for `feat!` and `BREAKING` and found nothing — because the three commits that broke
# them were typed `refactor:`:
#
#     7da5478  refactor  withdrew PIN_UNSAFE, VOLATILE, VOLATILE_JSON, default_generation,
#                        default_run_id from the package __all__
#     174f862  refactor  withdrew Capture, MemorySink, git, installed_packages, write_snapshot
#     b946716  refactor  renamed Run.write_json to Run.output_json
#
# A CONVENTION THAT RECORDS INTENT CANNOT SEE A BREAKAGE THE AUTHOR DID NOT INTEND. Every one
# of those was made deliberately and none was thought of as breaking, because each was framed
# as "this was never really promised" — which is true of the decision and false for the person
# who was importing the name.
#
# So this file does not record intent. It records the surface. Removing or renaming anything
# below forces an edit here, which shows up in the diff, which is the moment to type the
# commit `feat!` and write it in the CHANGELOG.
#
#   Name  [class] / [callable] / [value]   a promised top-level name
#   Name.member                            a public method or property of a promised class
#   Name:field                             a public dataclass field of a promised class
DEFAULT_CODE_PATHS  [value]
DEFAULT_TRACKED  [value]
HISTORY_SCHEMA  [value]
JsonlSink  [class]
JsonlSink.append
Project  [class]
Project.history_destination
Project.resolved_incomplete_dir
Project.resolved_run_log
Project.resolved_sink
Project.resolved_transformation_log
Project:allow_late_inputs
Project:auto_steps
Project:heartbeat
Project:progress
Project:code_paths
Project:env_snapshot_dir
Project:generation
Project:hash_imported_code
Project:imported_code_max
Project:root
Project:run_id
Project:run_log
Project:sidecar_per_run
Project:sink
Project:terminal_log_dir
Project:tracked_packages
Project:transformation_log
Project:warn_unregistered_reads
Project:write_transformation_log
Project:write_yaml_sidecar
RecordSink  [class]
RecordSink.append
Run  [class]
Run.code
Run.environment_snapshot
Run.header
Run.input
Run.module
Run.note
Run.open_output
Run.output
Run.output_json
Run.pin_sidecar
Run.seeds
Run.step
Run.terminal_log
Run.tool
Run.write
SCHEMA  [value]
START_SCHEMA  [value]
Terminated  [class]
active  [callable]
configure  [callable]
content_digest  [callable]
describe  [callable]
detect_root  [callable]
is_configured  [callable]
sha256  [callable]
to_yaml  [callable]
