docs(sandbox): stop referencing a non-existent game.log API#57
Merged
Conversation
print/eprint are stripped from the sandbox and no logging binding is registered, so there is no in-script logging facility. The sandbox guide and the loader comment both directed users to an asobi-side `game.log` API that does not exist. State the actual situation instead: surface diagnostics through game state or broadcast events.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
asobi-docs-auditorflagged a shared fiction across three surfaces: the sandbox docs direct users to an "asobi-sidegame.logAPI" for logging, but no such binding exists.print/eprintare stripped (asobi_lua_loader.erlL-1), andasobi_lua_api.erlregisters nologpath — there is currently no in-script logging facility.This fixes the two asobi_lua surfaces:
guides/security-sandbox.mdasobi_lua_loader.erlstrip-list comment(The matching site copy is fixed in widgrensit/asobi_site#67.)
Both now state the real situation: surface diagnostics through game state or broadcast events.
Whether to add a real
game.logbinding is a separate design decision (the sandbox deliberately strips stdout logging) — tracked separately, not done here.Verification
rebar3 fmt --check,compile,xref,eunit(223/223),elp lint(no warnings on the loader). ex_doc warnings present are all pre-existing and unrelated.